Lynar Studios - Standard Library - v2024.1.0.0 Documentation

Packages

boxing

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.

Classes

core

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.

Classes

encoding

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.

Classes

event

This package provides an event manager and the functionality to through events.

Classes

io

This package provides cross-platform functionalities for handling files, parsing and writing XML, logging, parsing and writing SP-files (.INI-based files).

Classes

time

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.

Classes

Classes

core.Class

This class represents a base class offering minimal reflection on the class name.

core.LibraryVersion

This class provides the version information of this library.

core.Version

This class represents a semantic versioning scheme.

core.ConditionalFunctionExecutor

This class can execute any method matching a specific signature based on a specific condition.

core.NullPointerArgumentEvaluator

This class evaluates whether a passed shared pointer argument is null.

core.NullPointerEvaluator

This class evaluates whether a passed shared pointer reference is null.

core.RawNullPointerArgumentEvaluator

This class evaluates whether a passed raw pointer argument is null.

core.IndexOutOfBoundsEvaluator

This class evaluates whether a passed index is out of bounds.

core.EmptyStringArgumentEvaluator

This class evaluates whether a passed string is empty.

core.RawNullPointerEvaluator

This class evaluates whether a passed raw pointer reference is null.

core.JniReturnValue

This class represents a method return value of a Java class within Java Native Interface (JNI) context.

core.JniClassParameter

This class holds important information for the usage of the Java Native Interface (JNI), like Java environment or a specific Java object.

core.JniApi

This class represents an API for the Java Native Interface (JNI) wrapping basic JNI end points.

core.JniMethod

This class represents a class method within Java Native Interface (JNI) context.

core.JniClass

This class represents a Java class within the Java Native Interface (JNI).

core.NullPointerException

This exception can be thrown in case a called reference is null.

core.EventNotHandledException

This exception can be thrown in case an event is not handled.

core.IllegalArgumentException

This exception can be thrown in case a passed argument is illegal, which can be individually interpreted.

core.FileOperationException

This exception can be thrown in case a file could not be processed, like opened or being read.

core.IllegalArithmeticOperationException

This exception can be thrown in case an arithmetic operation is illegal. One example would be the division by zero.

core.FileNotFoundException

This exception can be thrown in case a file could not be found.

core.IncompleteJsonException

This exception can be thrown when a passed JSON is incomplete - e.g. if a key is missing.

core.NotImplementedException

This exception can be thrown in case a called method is not implemented.

core.IndexOutOfBoundsException

This exception can be thrown in case an index of an array like structure is out of bounds.

core.Exception

This a base exception that can be thrown in any scenario.

boxing.Integer

This class represents the primitive datatype int and provides functionalities for arithmetic operations and string representation.

boxing.Boolean

This class represents the primitive datatype bool and provides functionalities for boolean expressions and string representation.

boxing.Double

This class represents the primitive datatype double and provides functionalities for arithmetic operations, accuracy and string representation.

boxing.Float

This class represents the primitive datatype float and provides functionalities for arithmetic operations, accuracy and string representation.

boxing.String

This class represents a string and provides operations, like filling and searching.

boxing.Long

This class represents the primitive datatype long and provides functionalities for arithmetic operations and string representation.

time.Date

This class represents a date and provides functionalities for string representation, arithmetic operations and time comparison.

time.DateParameter

This class holds information of a date processed by this library.

time.DateParameterMapper

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.

time.JniDateParameterMapper

This mapper is converting a date Java class to a date model class of this library.

time.SystemTimeParameter

This class holds information for setting the system time.

time.PosixClock

This is a POSIX based internal time.

time.SystemTime

This class represents the system time and can be set. This would require root privileges.

time.WindowsClock

This is a Windows based internal time.

encoding.Base64

This class can encode and decode the Base64 format.

event.Event

This class represents an event that can be invoked.

event.EventListener

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.

event.EventManager

This class can invoke all events known by subscribed listeners.

event.EventParameter

This class holds parameters which can be sent during event invocation.