123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281 |
- <!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_eventlistener">EventListener</a></li>
- <li class="class_li"><a class="default_link_layout" href="#event_eventmanager">EventManager</a></li>
- <li class="class_li"><a class="default_link_layout" href="#event_eventparameter">EventParameter</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="core_class">core.Class</h3>
- <p class="default_text">This class represents a base class offering minimal reflection on the class name.</p>
- <h3 id="core_libraryversion">core.LibraryVersion</h3>
- <p class="default_text">This class provides the version information of this library.</p>
- <h3 id="core_version">core.Version</h3>
- <p class="default_text">This class represents a semantic versioning scheme.</p>
- <h3 id="core_conditionalfunctionexecutor">core.ConditionalFunctionExecutor</h3>
- <p class="default_text">This class can execute any method matching a specific signature based on a specific condition.</p>
- <h3 id="core_nullpointerargumentevaluator">core.NullPointerArgumentEvaluator</h3>
- <p class="default_text">This class evaluates whether a passed shared pointer argument is null.</p>
- <h3 id="core_nullpointerevaluator">core.NullPointerEvaluator</h3>
- <p class="default_text">This class evaluates whether a passed shared pointer reference is null.</p>
- <h3 id="core_rawnullpointerargumentevaluator">core.RawNullPointerArgumentEvaluator</h3>
- <p class="default_text">This class evaluates whether a passed raw pointer argument is null.</p>
- <h3 id="core_indexoutofboundsevaluator">core.IndexOutOfBoundsEvaluator</h3>
- <p class="default_text">This class evaluates whether a passed index is out of bounds.</p>
- <h3 id="core_emptystringargumentevaluator">core.EmptyStringArgumentEvaluator</h3>
- <p class="default_text">This class evaluates whether a passed string is empty.</p>
- <h3 id="core_rawnullpointerevaluator">core.RawNullPointerEvaluator</h3>
- <p class="default_text">This class evaluates whether a passed raw pointer reference is null.</p>
- <h3 id="core_jnireturnvalue">core.JniReturnValue</h3>
- <p class="default_text">This class represents a method return value of a Java class within Java Native Interface (JNI) context.</p>
- <h3 id="core_jniclassparameter">core.JniClassParameter</h3>
- <p class="default_text">This class holds important information for the usage of the Java Native Interface (JNI), like Java environment or a specific Java object.</p>
- <h3 id="core_jniapi">core.JniApi</h3>
- <p class="default_text">This class represents an API for the Java Native Interface (JNI) wrapping basic JNI end points.</p>
- <h3 id="core_jnimethod">core.JniMethod</h3>
- <p class="default_text">This class represents a class method within Java Native Interface (JNI) context.</p>
- <h3 id="core_jniclass">core.JniClass</h3>
- <p class="default_text">This class represents a Java class within the Java Native Interface (JNI).</p>
- <h3 id="core_nullpointerexception">core.NullPointerException</h3>
- <p class="default_text">This exception can be thrown in case a called reference is null.</p>
- <h3 id="core_eventnothandledexception">core.EventNotHandledException</h3>
- <p class="default_text">This exception can be thrown in case an event is not handled.</p>
- <h3 id="core_illegalargumentexception">core.IllegalArgumentException</h3>
- <p class="default_text">This exception can be thrown in case a passed argument is illegal, which can be individually interpreted.</p>
- <h3 id="core_fileoperationexception">core.FileOperationException</h3>
- <p class="default_text">This exception can be thrown in case a file could not be processed, like opened or being read.</p>
- <h3 id="core_illegalarithmeticoperationexception">core.IllegalArithmeticOperationException</h3>
- <p class="default_text">This exception can be thrown in case an arithmetic operation is illegal. One example would be the division by zero.</p>
- <h3 id="core_filenotfoundexception">core.FileNotFoundException</h3>
- <p class="default_text">This exception can be thrown in case a file could not be found.</p>
- <h3 id="core_incompletejsonexception">core.IncompleteJsonException</h3>
- <p class="default_text">This exception can be thrown when a passed JSON is incomplete - e.g. if a key is missing.</p>
- <h3 id="core_notimplementedexception">core.NotImplementedException</h3>
- <p class="default_text">This exception can be thrown in case a called method is not implemented.</p>
- <h3 id="core_indexoutofboundsexception">core.IndexOutOfBoundsException</h3>
- <p class="default_text">This exception can be thrown in case an index of an array like structure is out of bounds.</p>
- <h3 id="core_exception">core.Exception</h3>
- <p class="default_text">This a base exception that can be thrown in any scenario.</p>
- <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>
- <h3 id="time_date">time.Date</h3>
- <p class="default_text">This class represents a date and provides functionalities for string representation, arithmetic operations and time comparison.</p>
- <h3 id="time_dateparameter">time.DateParameter</h3>
- <p class="default_text">This class holds information of a date processed by this library.</p>
- <h3 id="time_dateparametermapper">time.DateParameterMapper</h3>
- <p class="default_text">This class maps date information to either an internal POSIX clock or an internal Windows clock, which can then be processed for setting the system time.</p>
- <h3 id="time_jnidateparametermapper">time.JniDateParameterMapper</h3>
- <p class="default_text">This mapper is converting a date Java class to a date model class of this library.</p>
- <h3 id="time_systemtimeparameter">time.SystemTimeParameter</h3>
- <p class="default_text">This class holds information for setting the system time.</p>
- <h3 id="time_posixclock">time.PosixClock</h3>
- <p class="default_text">This is a POSIX based internal time.</p>
- <h3 id="time_systemtime">time.SystemTime</h3>
- <p class="default_text">This class represents the system time and can be set. This would require root privileges.</p>
- <h3 id="time_windowsclock">time.WindowsClock</h3>
- <p class="default_text">This is a Windows based internal time.</p>
- <h3 id="encoding_base64">encoding.Base64</h3>
- <p class="default_text">This class can encode and decode the Base64 format.</p>
- <h3 id="event_event">event.Event</h3>
- <p class="default_text">This class represents an event that can be invoked.</p>
- <h3 id="event_eventlistener">event.EventListener</h3>
- <p class="default_text">An instance of this class can listen to any event. Usually, this class is used as base class of any class that must listen to an event.</p>
- <h3 id="event_eventmanager">event.EventManager</h3>
- <p class="default_text">This class can invoke all events known by subscribed listeners.</p>
- <h3 id="event_eventparameter">event.EventParameter</h3>
- <p class="default_text">This class holds parameters which can be sent during event invocation.</p>
- </body>
- </html>
|