|
|
@@ -0,0 +1,379 @@
|
|
|
+<!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: #151517;
|
|
|
+ font-family: Arial, serif;
|
|
|
+ color: #727274;
|
|
|
+}
|
|
|
+a.default_link_layout:link
|
|
|
+{
|
|
|
+ color: #727274;
|
|
|
+ text-decoration: none;
|
|
|
+}
|
|
|
+a.default_link_layout:visited
|
|
|
+{
|
|
|
+ color: #727274;
|
|
|
+ text-decoration: none;
|
|
|
+}
|
|
|
+a.default_link_layout:hover
|
|
|
+{
|
|
|
+ color: #4e4944;
|
|
|
+ text-decoration: none;
|
|
|
+}
|
|
|
+a.default_link_layout:active
|
|
|
+{
|
|
|
+ color: #4e4944;
|
|
|
+ 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="io_filewriter">io.FileWriter</h3>
|
|
|
+<p class="default_text">This class can write to a file.</p>
|
|
|
+<h3 id="io_filepathseparatormatch">io.FilePathSeparatorMatch</h3>
|
|
|
+<p class="default_text">This class can filter file path separators.</p>
|
|
|
+<h3 id="io_fileoutputstream">io.FileOutputStream</h3>
|
|
|
+<p class="default_text">This class can be used for writing to a file stream.</p>
|
|
|
+<h3 id="io_storablefile">io.StorableFile</h3>
|
|
|
+<p class="default_text">This class can be used to store any serialized information to a file.</p>
|
|
|
+<h3 id="io_newline">io.NewLine</h3>
|
|
|
+<p class="default_text">This class can be used as new line based on the preferred operating system. Currently, Windows and Unix-like operating systems are supported.</p>
|
|
|
+<h3 id="io_filereader">io.FileReader</h3>
|
|
|
+<p class="default_text">This class can read the content of a file and return it as byte field.</p>
|
|
|
+<h3 id="io_file">io.File</h3>
|
|
|
+<p class="default_text">This class represents a file in the file system and provides functionalities for location, operations and fetching property information.</p>
|
|
|
+<h3 id="io_standardoutputwriter">io.StandardOutputWriter</h3>
|
|
|
+<p class="default_text">This class can be used to write a string to stdout.</p>
|
|
|
+<h3 id="io_filepathseparator">io.FilePathSeparator</h3>
|
|
|
+<p class="default_text">This class represents the OS specific separator withing file paths on either Windows- or Unix-like operating systems.</p>
|
|
|
+<h3 id="io_fileexistenceevaluator">io.FileExistenceEvaluator</h3>
|
|
|
+<p class="default_text">This class evaluates whether a file exists and throws an exception in case it does not.</p>
|
|
|
+<h3 id="io_sectionpairmessageformatter">io.SectionPairMessageFormatter</h3>
|
|
|
+<p class="default_text">This message formatter replaces new line sequences, which are OS specific, to a readable tag for error message formatting.</p>
|
|
|
+<h3 id="io_sectionpairfilereaderparameter">io.SectionPairFileReaderParameter</h3>
|
|
|
+<p class="default_text">This class holds evaluators and the document instance for Section Pair file reading.</p>
|
|
|
+<h3 id="io_sectionpairfilereader">io.SectionPairFileReader</h3>
|
|
|
+<p class="default_text">This class reads a Section Pair file and writes it to a Section Pair document instance.</p>
|
|
|
+<h3 id="io_sectionpairsectionargumentevaluator">io.SectionPairSectionArgumentEvaluator</h3>
|
|
|
+<p class="default_text">This class checks whether a whole section argument is valid and throws an exception if that is not the case.</p>
|
|
|
+<h3 id="io_sectionpairvalueargumentevaluator">io.SectionPairValueArgumentEvaluator</h3>
|
|
|
+<p class="default_text">This class checks whether a value argument is valid and throws an exception if that is not the case.</p>
|
|
|
+<h3 id="io_sectionpairrowlistvalueargumentevaluator">io.SectionPairRowListValueArgumentEvaluator</h3>
|
|
|
+<p class="default_text">This class checks whether a row list value argument is valid and throws an exception if that is not the case.</p>
|
|
|
+<h3 id="io_sectionpairrowsinglevalueargumentevaluator">io.SectionPairRowSingleValueArgumentEvaluator</h3>
|
|
|
+<p class="default_text">This class checks whether a single row value argument is valid and throws an exception if that is not the case.</p>
|
|
|
+<h3 id="io_sectionpairrowargumentevaluator">io.SectionPairRowArgumentEvaluator</h3>
|
|
|
+<p class="default_text">This class checks whether a row argument is valid and throws an exception if that is not the case.</p>
|
|
|
+<h3 id="io_sectionpairidentifierargumentevaluator">io.SectionPairIdentifierArgumentEvaluator</h3>
|
|
|
+<p class="default_text">This class checks whether an identifier argument is valid and throws an exception if that is not the case.</p>
|
|
|
+<h3 id="io_sectionpairidentifiervalidator">io.SectionPairIdentifierValidator</h3>
|
|
|
+<p class="default_text">This validator checks whether a string is a valid Section Pair identifier.</p>
|
|
|
+<h3 id="io_sectionpairsectionvalidator">io.SectionPairSectionValidator</h3>
|
|
|
+<p class="default_text">This validator checks whether a content is a valid Section Pair section.</p>
|
|
|
+<h3 id="io_sectionpairrowlistvaluevalidator">io.SectionPairRowListValueValidator</h3>
|
|
|
+<p class="default_text">This validator checks whether a content is a valid Section Pair row list value.</p>
|
|
|
+<h3 id="io_sectionpairrowsinglevaluevalidator">io.SectionPairRowSingleValueValidator</h3>
|
|
|
+<p class="default_text">This validator checks whether a content is a valid Section Pair row single value.</p>
|
|
|
+<h3 id="io_sectionpairdocumentvalidator">io.SectionPairDocumentValidator</h3>
|
|
|
+<p class="default_text">This validator checks whether a content is a valid Section Pair document.</p>
|
|
|
+<h3 id="io_sectionpairvaluevalidator">io.SectionPairValueValidator</h3>
|
|
|
+<p class="default_text">This validator checks whether a content is a valid Section Pair value.</p>
|
|
|
+<h3 id="io_sectionpairfileextensionvalidator">io.SectionPairFileExtensionValidator</h3>
|
|
|
+<p class="default_text">This validator checks whether a file name has a valid Section Pair file extension.</p>
|
|
|
+<h3 id="io_sectionpairrowvalidator">io.SectionPairRowValidator</h3>
|
|
|
+<p class="default_text">This validator checks whether a content is a valid Section Pair row.</p>
|
|
|
+<h3 id="io_serializablesectionpairsection">io.SerializableSectionPairSection</h3>
|
|
|
+<p class="default_text">This class can serialize a Section Pair section for file persistence.</p>
|
|
|
+<h3 id="io_serializablesectionpairrowsinglevalue">io.SerializableSectionPairRowSingleValue</h3>
|
|
|
+<p class="default_text">This class can serialize a Section Pair single value for file persistence.</p>
|
|
|
+<h3 id="io_serializablesectionpairrow">io.SerializableSectionPairRow</h3>
|
|
|
+<p class="default_text">This class can serialize a Section Pair row for file persistence.</p>
|
|
|
+<h3 id="io_serializablesectionpairrowlistvalue">io.SerializableSectionPairRowListValue</h3>
|
|
|
+<p class="default_text">This class can serialize a Section Pair row list value for file persistence.</p>
|
|
|
+<h3 id="io_serializablesectionpairparameter">io.SerializableSectionPairParameter</h3>
|
|
|
+<p class="default_text">This class is holding information for Section Pair serialization.</p>
|
|
|
+<h3 id="io_serializablesectionpairdocument">io.SerializableSectionPairDocument</h3>
|
|
|
+<p class="default_text">This class can serialize a Section Pair document for file persistence.</p>
|
|
|
+<h3 id="io_sectionpairrowvalue">io.SectionPairRowValue</h3>
|
|
|
+<p class="default_text">This class represents a Section Pair row value.</p>
|
|
|
+<h3 id="io_sectionpairdocument">io.SectionPairDocument</h3>
|
|
|
+<p class="default_text">This class represents a whole Section Pair document.</p>
|
|
|
+<h3 id="io_sectionpairrowlistvalue">io.SectionPairRowListValue</h3>
|
|
|
+<p class="default_text">This class represents a Section Pair row list value.</p>
|
|
|
+<h3 id="io_sectionpairrow">io.SectionPairRow</h3>
|
|
|
+<p class="default_text">This class represents a Section Pair row.</p>
|
|
|
+<h3 id="io_sectionpairsection">io.SectionPairSection</h3>
|
|
|
+<p class="default_text">This class represents a Section Pair section.</p>
|
|
|
+<h3 id="io_sectionpairrowsinglevalue">io.SectionPairRowSingleValue</h3>
|
|
|
+<p class="default_text">This class represents a Section Pair row single value.</p>
|
|
|
+<h3 id="io_xmldeclaration">io.XmlDeclaration</h3>
|
|
|
+<p class="default_text">This class represents an XML declaration and can be serialized to an XML tag.</p>
|
|
|
+<h3 id="io_xmlparser">io.XmlParser</h3>
|
|
|
+<p class="default_text">This class parses a whole XML tree in form of an XML document.</p>
|
|
|
+<h3 id="io_xmlreader">io.XmlReader</h3>
|
|
|
+<p class="default_text">This class reads an XML file and returns an XML document.</p>
|
|
|
+<h3 id="io_xmldocument">io.XmlDocument</h3>
|
|
|
+<p class="default_text">This class represents a whole XML document and can be serialized to a whole XML tree.</p>
|
|
|
+<h3 id="io_xmlattribute">io.XmlAttribute</h3>
|
|
|
+<p class="default_text">This class represents an XML attribute and can be serialized to an XML tag.</p>
|
|
|
+<h3 id="io_xmlparseparameter">io.XmlParseParameter</h3>
|
|
|
+<p class="default_text">This class holds information regarding parsing an XML tree.</p>
|
|
|
+<h3 id="io_xmlnode">io.XmlNode</h3>
|
|
|
+<p class="default_text">This class represents an XML node and can be serialized to an XML tree.</p>
|
|
|
+<h3 id="io_logger">io.Logger</h3>
|
|
|
+<p class="default_text">This is a logger which can log to any implemented target.</p>
|
|
|
+<h3 id="io_loglevel">io.LogLevel</h3>
|
|
|
+<p class="default_text">This class represents the log level controlling how noisy a log should be.</p>
|
|
|
+<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_exceptionmessage">core.ExceptionMessage</h3>
|
|
|
+<p class="default_text">This is the message container being used by these libraries provided exceptions.</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>
|
