|
|
@@ -0,0 +1,203 @@
|
|
|
+<!DOCTYPE html>
|
|
|
+<html lang="en">
|
|
|
+<head>
|
|
|
+<title>Coline - C++ Documentation</title>
|
|
|
+<meta charset="UTF-8">
|
|
|
+<meta name="description" content="This documentation was created with Coline.">
|
|
|
+<meta name="author" content="Patrick-Christopher Mattulat">
|
|
|
+<meta name="keywords" content="Coline, C++-Documentation, Lynar Studios, Lynar Studios - Standard Library">
|
|
|
+<style>
|
|
|
+body
|
|
|
+{
|
|
|
+ background-color: #ffffff;
|
|
|
+ font-family: Arial, serif;
|
|
|
+ color: #1a2a3f;
|
|
|
+}
|
|
|
+a.default_link_layout:link
|
|
|
+{
|
|
|
+ color: #1a2a3f;
|
|
|
+ text-decoration: none;
|
|
|
+}
|
|
|
+a.default_link_layout:visited
|
|
|
+{
|
|
|
+ color: #1a2a3f;
|
|
|
+ text-decoration: none;
|
|
|
+}
|
|
|
+a.default_link_layout:hover
|
|
|
+{
|
|
|
+ color: #bc8003;
|
|
|
+ text-decoration: none;
|
|
|
+}
|
|
|
+a.default_link_layout:active
|
|
|
+{
|
|
|
+ color: #bc8003;
|
|
|
+ text-decoration: none;
|
|
|
+}
|
|
|
+p.default_text
|
|
|
+{
|
|
|
+ color: inherit;
|
|
|
+ font-size: 16px;
|
|
|
+ text-decoration: none;
|
|
|
+ font-weight: normal;
|
|
|
+}
|
|
|
+li.package_li
|
|
|
+{
|
|
|
+ font-size: 16px;
|
|
|
+ text-decoration: none;
|
|
|
+ font-weight: normal;
|
|
|
+}
|
|
|
+li.class_li
|
|
|
+{
|
|
|
+ font-size: 16px;
|
|
|
+ text-decoration: none;
|
|
|
+ font-weight: normal;
|
|
|
+}
|
|
|
+</style>
|
|
|
+</head>
|
|
|
+<body>
|
|
|
+<h1>Lynar Studios - Standard Library - v2024.1.0.0 Documentation</h1>
|
|
|
+<h2>Packages</h2>
|
|
|
+<ul id="package_list">
|
|
|
+<li class="package_li"><a class="default_link_layout" href="#package_boxing">boxing</a></li>
|
|
|
+<li class="package_li"><a class="default_link_layout" href="#package_core">core</a></li>
|
|
|
+<li class="package_li"><a class="default_link_layout" href="#package_encoding">encoding</a></li>
|
|
|
+<li class="package_li"><a class="default_link_layout" href="#package_event">event</a></li>
|
|
|
+<li class="package_li"><a class="default_link_layout" href="#package_io">io</a></li>
|
|
|
+<li class="package_li"><a class="default_link_layout" href="#package_time">time</a></li>
|
|
|
+</ul>
|
|
|
+<h3 id="package_boxing">boxing</h3>
|
|
|
+<p class="default_text">This package provides functionalities for wrapping primitive datatypes (boolean, double, float, int, long, string). Wrapping those types would enable a developer to provide string representations, or parsing from strings to convert them back into their primitive forms. Additionally, these boxing types come with a great selection of operators and convenient functions.</p>
|
|
|
+<h4>Classes</h4>
|
|
|
+<ul id="boxing_class_list">
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#boxing_integer">Integer</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#boxing_boolean">Boolean</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#boxing_double">Double</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#boxing_float">Float</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#boxing_string">String</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#boxing_long">Long</a></li>
|
|
|
+</ul>
|
|
|
+<h3 id="package_core">core</h3>
|
|
|
+<p class="default_text">This package provides a base class, which can be used to provide simple class reflection. Other functionalities of this package include customized exceptions, basic interfaces and convenient types.</p>
|
|
|
+<h4>Classes</h4>
|
|
|
+<ul id="core_class_list">
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_class">Class</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_libraryversion">LibraryVersion</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_version">Version</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_conditionalfunctionexecutor">ConditionalFunctionExecutor</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_nullpointerargumentevaluator">NullPointerArgumentEvaluator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_nullpointerevaluator">NullPointerEvaluator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_rawnullpointerargumentevaluator">RawNullPointerArgumentEvaluator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_indexoutofboundsevaluator">IndexOutOfBoundsEvaluator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_emptystringargumentevaluator">EmptyStringArgumentEvaluator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_rawnullpointerevaluator">RawNullPointerEvaluator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_jnireturnvalue">JniReturnValue</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_jniclassparameter">JniClassParameter</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_jniapi">JniApi</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_jnimethod">JniMethod</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_jniclass">JniClass</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_nullpointerexception">NullPointerException</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_eventnothandledexception">EventNotHandledException</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_illegalargumentexception">IllegalArgumentException</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_exceptionmessage">ExceptionMessage</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_fileoperationexception">FileOperationException</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_illegalarithmeticoperationexception">IllegalArithmeticOperationException</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_filenotfoundexception">FileNotFoundException</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_incompletejsonexception">IncompleteJsonException</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_notimplementedexception">NotImplementedException</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_indexoutofboundsexception">IndexOutOfBoundsException</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#core_exception">Exception</a></li>
|
|
|
+</ul>
|
|
|
+<h3 id="package_encoding">encoding</h3>
|
|
|
+<p class="default_text">This package provides encoding functionalities, which in the current scope is limited to Base64. This would also include the provision of a Base-64-CLI-tool.</p>
|
|
|
+<h4>Classes</h4>
|
|
|
+<ul id="encoding_class_list">
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#encoding_base64">Base64</a></li>
|
|
|
+</ul>
|
|
|
+<h3 id="package_event">event</h3>
|
|
|
+<p class="default_text">This package provides an event manager and the functionality to through events.</p>
|
|
|
+<h4>Classes</h4>
|
|
|
+<ul id="event_class_list">
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#event_event">Event</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#event_eventmanager">EventManager</a></li>
|
|
|
+</ul>
|
|
|
+<h3 id="package_io">io</h3>
|
|
|
+<p class="default_text">This package provides cross-platform functionalities for handling files, parsing and writing XML, logging, parsing and writing SP-files (.INI-based files).</p>
|
|
|
+<h4>Classes</h4>
|
|
|
+<ul id="io_class_list">
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_filewriter">FileWriter</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_filepathseparatormatch">FilePathSeparatorMatch</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_fileoutputstream">FileOutputStream</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_storablefile">StorableFile</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_newline">NewLine</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_filereader">FileReader</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_file">File</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_standardoutputwriter">StandardOutputWriter</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_filepathseparator">FilePathSeparator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_fileexistenceevaluator">FileExistenceEvaluator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairmessageformatter">SectionPairMessageFormatter</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairfilereaderparameter">SectionPairFileReaderParameter</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairfilereader">SectionPairFileReader</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairsectionargumentevaluator">SectionPairSectionArgumentEvaluator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairvalueargumentevaluator">SectionPairValueArgumentEvaluator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairrowlistvalueargumentevaluator">SectionPairRowListValueArgumentEvaluator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairrowsinglevalueargumentevaluator">SectionPairRowSingleValueArgumentEvaluator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairrowargumentevaluator">SectionPairRowArgumentEvaluator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairidentifierargumentevaluator">SectionPairIdentifierArgumentEvaluator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairidentifiervalidator">SectionPairIdentifierValidator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairsectionvalidator">SectionPairSectionValidator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairrowlistvaluevalidator">SectionPairRowListValueValidator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairrowsinglevaluevalidator">SectionPairRowSingleValueValidator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairdocumentvalidator">SectionPairDocumentValidator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairvaluevalidator">SectionPairValueValidator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairfileextensionvalidator">SectionPairFileExtensionValidator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairrowvalidator">SectionPairRowValidator</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_serializablesectionpairsection">SerializableSectionPairSection</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_serializablesectionpairrowsinglevalue">SerializableSectionPairRowSingleValue</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_serializablesectionpairrow">SerializableSectionPairRow</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_serializablesectionpairrowlistvalue">SerializableSectionPairRowListValue</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_serializablesectionpairparameter">SerializableSectionPairParameter</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_serializablesectionpairdocument">SerializableSectionPairDocument</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairrowvalue">SectionPairRowValue</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairdocument">SectionPairDocument</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairrowlistvalue">SectionPairRowListValue</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairrow">SectionPairRow</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairsection">SectionPairSection</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_sectionpairrowsinglevalue">SectionPairRowSingleValue</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_xmldeclaration">XmlDeclaration</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_xmlparser">XmlParser</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_xmlreader">XmlReader</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_xmldocument">XmlDocument</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_xmlattribute">XmlAttribute</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_xmlparseparameter">XmlParseParameter</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_xmlnode">XmlNode</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_logger">Logger</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#io_loglevel">LogLevel</a></li>
|
|
|
+</ul>
|
|
|
+<h3 id="package_time">time</h3>
|
|
|
+<p class="default_text">This package provides convenient time functionalities and data structures, like a Date class for representing a date or SystemTime for setting a systems local time.</p>
|
|
|
+<h4>Classes</h4>
|
|
|
+<ul id="time_class_list">
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#time_date">Date</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#time_dateparameter">DateParameter</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#time_dateparametermapper">DateParameterMapper</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#time_jnidateparametermapper">JniDateParameterMapper</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#time_systemtimeparameter">SystemTimeParameter</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#time_posixclock">PosixClock</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#time_systemtime">SystemTime</a></li>
|
|
|
+<li class="class_li"><a class="default_link_layout" href="#time_windowsclock">WindowsClock</a></li>
|
|
|
+</ul>
|
|
|
+<h2>Classes</h2>
|
|
|
+<h3 id="boxing_integer">boxing.Integer</h3>
|
|
|
+<p class="default_text">This class represents the primitive datatype int and provides functionalities for arithmetic operations and string representation.</p>
|
|
|
+<h3 id="boxing_boolean">boxing.Boolean</h3>
|
|
|
+<p class="default_text">This class represents the primitive datatype bool and provides functionalities for boolean expressions and string representation.</p>
|
|
|
+<h3 id="boxing_double">boxing.Double</h3>
|
|
|
+<p class="default_text">This class represents the primitive datatype double and provides functionalities for arithmetic operations, accuracy and string representation.</p>
|
|
|
+<h3 id="boxing_float">boxing.Float</h3>
|
|
|
+<p class="default_text">This class represents the primitive datatype float and provides functionalities for arithmetic operations, accuracy and string representation.</p>
|
|
|
+<h3 id="boxing_string">boxing.String</h3>
|
|
|
+<p class="default_text">This class represents a string and provides operations, like filling and searching.</p>
|
|
|
+<h3 id="boxing_long">boxing.Long</h3>
|
|
|
+<p class="default_text">This class represents the primitive datatype long and provides functionalities for arithmetic operations and string representation.</p>
|
|
|
+</body>
|
|
|
+</html>
|
