Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractTask - Class in org.omegazero.common.event.task
-
A
Taskwith arguments passed to a task handler. - AbstractTask(Object[]) - Constructor for class org.omegazero.common.event.task.AbstractTask
-
Creates a new
AbstractTaskwith priority0. - AbstractTask(Object[], int) - Constructor for class org.omegazero.common.event.task.AbstractTask
-
Creates a new
AbstractTask. - AbstractTaskQueueExecutor - Class in org.omegazero.common.event
-
Used for queuing and running
Tasks. - AbstractTaskQueueExecutor() - Constructor for class org.omegazero.common.event.AbstractTaskQueueExecutor
- accept(T) - Method in interface org.omegazero.common.util.function.SpecificThrowingConsumer
-
Runs this
ThrowingConsumer. - addEventListener(String, GenericRunnable) - Method in class org.omegazero.common.event.EventEmitter
-
Registers the given event listener for the given event
name. - addEventListenerOnce(String, GenericRunnable) - Method in class org.omegazero.common.event.EventEmitter
-
Registers the given event listener for the given event
name. - addFineLogListener(BiConsumer<LogLevel, String>) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Same as
LoggerUtil.addLogListener(BiConsumer), except that listeners added here will receive all log messages, regardless of the configured log level. - addLoggerOutput(LoggerOutput) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Adds the given
LoggerOutputto the list of configured outputs. - addLogListener(BiConsumer<LogLevel, String>) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Adds a log listener.
- addPlugin(Plugin) - Method in class org.omegazero.common.plugins.PluginClassLoader
-
Adds the given plugin to the search path.
- ALLOW_DIRS - Static variable in class org.omegazero.common.plugins.PluginManager
-
Allow loading plugins that are not contained within a single file but within a directory.
- ALLOW_NONJAR - Static variable in class org.omegazero.common.plugins.PluginManager
-
Try to load any files, not only files ending with
.jar. - Application - Interface in org.omegazero.common.runtime
-
Represents an application managed by the
ApplicationWrapper. - ApplicationWrapper - Class in org.omegazero.common.runtime
-
Provides standard runtime setup procedures for the standalone application running in this runtime.
- ApplicationWrapper() - Constructor for class org.omegazero.common.runtime.ApplicationWrapper
- apply(T) - Method in interface org.omegazero.common.util.function.SpecificThrowingFunction
-
Performs an operation on the given object and returns its result.
- Args - Class in org.omegazero.common.util
-
Class used for parsing command line arguments.
- Args() - Constructor for class org.omegazero.common.util.Args
- Args.DefaultFormat - Class in org.omegazero.common.util
-
An
Argsimplementation for the default argument format. - arguments - Variable in class org.omegazero.common.util.Args
-
The argument data.
- ArrayUtil - Class in org.omegazero.common.util
-
Utility functions for arrays.
- async(Runnable) - Static method in class org.omegazero.common.event.Tasks
-
Queues the given
Runnableto be run asychronously, as soon as possible. - async(Consumer<Object[]>, Object...) - Static method in class org.omegazero.common.event.Tasks
-
Queues the given
Consumerwith the given arguments to be run asychronously, as soon as possible. - AttachmentContainer - Interface in org.omegazero.common.util
-
Represents an object that can hold attachments (any
Objects), each identified by a unique name string. - attachments - Variable in class org.omegazero.common.util.SimpleAttachmentContainer
-
Map containing the values of this
SimpleAttachmentContainer.
B
- build() - Method in class org.omegazero.common.event.TaskQueueExecutor.Builder
-
Builds a
TaskQueueExecutorwith previously set parameters. - byteArrayIndexOf(byte[], byte[]) - Static method in class org.omegazero.common.util.ArrayUtil
-
Deprecated.
- byteArrayIndexOf(byte[], byte[], int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Deprecated.Since 2.7, use the equivalent method
ArrayUtil.indexOf(byte[], byte[], int)instead
C
- callMethod(String, Object...) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Calls the method identified by the given identifier, which has the format "
<full class name>::<method signature>", with the given arguments. - callMethodOptional(String, Object...) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Calls the method identified by the given identifier.
- cancel() - Method in class org.omegazero.common.event.TaskScheduler.TimerTask
-
Cancels this task.
- cancel() - Method in class org.omegazero.common.eventbus.Event
-
Cancels this event.
- check() - Method in class org.omegazero.common.logging.LoggerUtil.LUPermission
- CHECK_TIMEOUT - Static variable in class org.omegazero.common.logging.RotatingFileLoggerOutput
-
System property
org.omegazero.common.logging.rotation.checkTimeout - checkArgc(int) - Method in interface org.omegazero.common.event.runnable.GenericRunnable
-
Checks whether
countis the correct number of arguments for thisGenericRunnable. - checkBounds(boolean[], int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Checks whether offset and length specify a valid set of elements in the array.
- checkBounds(byte[], int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Checks whether offset and length specify a valid set of elements in the array.
- checkBounds(char[], int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Checks whether offset and length specify a valid set of elements in the array.
- checkBounds(double[], int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Checks whether offset and length specify a valid set of elements in the array.
- checkBounds(float[], int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Checks whether offset and length specify a valid set of elements in the array.
- checkBounds(int[], int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Checks whether offset and length specify a valid set of elements in the array.
- checkBounds(long[], int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Checks whether offset and length specify a valid set of elements in the array.
- checkBounds(short[], int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Checks whether offset and length specify a valid set of elements in the array.
- checkBounds(T[], int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Checks whether offset and length specify a valid set of elements in the array.
- checkWorkers() - Method in class org.omegazero.common.event.EventQueueExecutor
-
Deprecated.Ensures that there are enough worker threads available for executing queued tasks.
- clear(long) - Static method in class org.omegazero.common.event.Tasks
-
Deprecated.Since 2.9.1, use
Tasks.I - clear(long) - Method in class org.omegazero.common.event.TaskScheduler
-
Deprecated.Since 2.9.1, because of poor efficiency. Use
TaskScheduler.clear(TimerTask)orTaskScheduler.clear(Object)instead. - clear(Object) - Method in class org.omegazero.common.event.TaskScheduler
-
Cancels the given timer task.
- clear(TaskScheduler.TimerTask) - Static method in class org.omegazero.common.event.Tasks
-
Deprecated.Since 2.9.1, use
Tasks.I - clear(TaskScheduler.TimerTask) - Method in class org.omegazero.common.event.TaskScheduler
-
Cancels the given timer task.
- clearTasks() - Method in class org.omegazero.common.event.EventQueue
-
Deprecated.Removes all queued tasks from the event queue.
- clone() - Method in class org.omegazero.common.config.ConfigArray
-
Returns a clone of this
ConfigArray, which contains the same elements as thisConfigArray. - clone() - Method in class org.omegazero.common.config.ConfigObject
-
Returns a clone of this
ConfigObject, which contains the same elements as thisConfigObject. - close() - Method in class org.omegazero.common.logging.FileLoggerOutput
- close() - Method in interface org.omegazero.common.logging.LoggerOutput
-
Closes this
LoggerOutput, flushing any remaining data and freeing resources. - close() - Static method in class org.omegazero.common.logging.LoggerUtil
-
Saves the log buffer and resets the LoggerUtil.
- close() - Method in interface org.omegazero.common.runtime.Application
-
Stops the application
- codeSource - Variable in class org.omegazero.common.plugins.Plugin.LoadedClassFile
- color() - Method in enum class org.omegazero.common.logging.LogLevel
-
Returns the ANSI escape sequence string for setting the output terminal text to an appropriate color.
- compareTo(Task) - Method in interface org.omegazero.common.event.task.Task
-
Compares this
Taskto the givenTask. - ConfigArray - Class in org.omegazero.common.config
-
A read-only array of any type of data, providing a layer of abstraction for different data representations.
- ConfigArray() - Constructor for class org.omegazero.common.config.ConfigArray
-
Creates an empty
ConfigArray. - ConfigArray(int) - Constructor for class org.omegazero.common.config.ConfigArray
-
Deprecated.
- ConfigArray(List<Object>) - Constructor for class org.omegazero.common.config.ConfigArray
-
Creates a
ConfigArraywith the given elements. - ConfigObject - Class in org.omegazero.common.config
-
A read-only map of key-value pairs, where the value is any type of data identified by the key string, providing a layer of abstraction for different data representations.
- ConfigObject() - Constructor for class org.omegazero.common.config.ConfigObject
-
Creates an empty
ConfigObject. - ConfigObject(Map<String, Object>) - Constructor for class org.omegazero.common.config.ConfigObject
-
Creates a
ConfigObjectwith the given data. - Configuration - Interface in org.omegazero.common.config
-
An interface for managing configuration files or similar.
- ConfigurationException - Exception Class in org.omegazero.common.config
-
Exception thrown when an error occurs while loading or processing a configuration.
- ConfigurationException(String) - Constructor for exception class org.omegazero.common.config.ConfigurationException
-
Creates a new
ConfigurationExceptionwith the specified message. - ConfigurationException(String, Throwable) - Constructor for exception class org.omegazero.common.config.ConfigurationException
-
Creates a new
ConfigurationExceptionwith the specified message and cause. - ConfigurationOption - Annotation Interface in org.omegazero.common.config
-
An annotation required on fields populated by
Configurationimplementations. - contains(Object) - Method in class org.omegazero.common.config.ConfigArray
-
Returns whether the given element o is in this
ConfigArray. - containsAll(Collection<?>) - Method in class org.omegazero.common.config.ConfigArray
-
Returns whether all elements in the given
Collectionare contained in thisConfigArray. - containsKey(Object) - Method in class org.omegazero.common.config.ConfigObject
-
Returns whether the given key exists in this
ConfigObject. - containsValue(Object) - Method in class org.omegazero.common.config.ConfigObject
-
Returns whether the given value exists in this
ConfigObject. - convertJSONArray(JSONArray) - Static method in class org.omegazero.common.config.JSONConfiguration
-
Converts the given
JSONArrayto aConfigArray. - convertJSONObject(JSONObject) - Static method in class org.omegazero.common.config.JSONConfiguration
-
Converts the given
JSONObjectto aConfigObject. - convertJSONValue(Object) - Static method in class org.omegazero.common.config.JSONConfiguration
-
Converts the given, possibly JSON-specific, object v to an abstracted data representation.
- copyData() - Method in class org.omegazero.common.config.ConfigArray
-
Creates a new
ArrayListwith all values of thisConfigArray. - copyData() - Method in class org.omegazero.common.config.ConfigObject
-
Creates a new
HashMapwith all values of thisConfigObject. - create() - Static method in interface org.omegazero.common.logging.Logger
-
Creates a new logger bound to the calling class.
- createEventId(String) - Method in class org.omegazero.common.event.EventEmitter
-
Creates an ID for the given event name used for more efficient event dispatching.
- createEventId(String, int) - Method in class org.omegazero.common.event.EventEmitter
-
Creates an ID for the given event name used for more efficient event dispatching.
- createEventSignature(String, Class<?>[], Class<?>) - Static method in class org.omegazero.common.eventbus.Event
-
Creates a string containing unambiguous information about the given
params,returnTypeand name of a method. - createLogger() - Static method in class org.omegazero.common.logging.LoggerUtil
-
Creates a new logger bound to the calling class.
- createLogger(int) - Static method in class org.omegazero.common.logging.LoggerUtil
- createLogger(Class<?>) - Static method in class org.omegazero.common.logging.LoggerUtil
D
- daemon() - Method in class org.omegazero.common.event.TaskScheduler.TimerTask
-
Marks this task as a daemon task.
- daemon(boolean) - Method in class org.omegazero.common.event.TaskQueueExecutor.Builder
-
Sets whether worker threads of the
TaskQueueExecutorshould be daemon threads. - data - Variable in class org.omegazero.common.config.ConfigArray
-
The data.
- data - Variable in class org.omegazero.common.config.ConfigObject
-
The data.
- data - Variable in class org.omegazero.common.plugins.Plugin.LoadedClassFile
- debug() - Method in interface org.omegazero.common.logging.Logger
-
Utility function to check if debugging is enabled.
- debug(Object...) - Method in interface org.omegazero.common.logging.Logger
-
Logs the given message at
LogLevel.DEBUG. - DEBUG - Enum constant in enum class org.omegazero.common.logging.LogLevel
-
Log level including messages for basic debugging.
- DefaultFormat() - Constructor for class org.omegazero.common.util.Args.DefaultFormat
- DeferringTaskQueueExecutor - Class in org.omegazero.common.event
-
An
AbstractTaskQueueExecutordeferring all queued tasks until anotherAbstractTaskQueueExecutorimplementation is available. - DeferringTaskQueueExecutor() - Constructor for class org.omegazero.common.event.DeferringTaskQueueExecutor
-
Creates a new
DeferringTaskQueueExecutorwith parameter maxDeferredTasks set to 1024. - DeferringTaskQueueExecutor(int) - Constructor for class org.omegazero.common.event.DeferringTaskQueueExecutor
-
Creates a new
DeferringTaskQueueExecutor. - DelegatingTaskQueueExecutor - Class in org.omegazero.common.event
-
An
AbstractTaskQueueExecutordelegating all tasks to anotherAbstractTaskQueueExecutorimplementation. - DelegatingTaskQueueExecutor(AbstractTaskQueueExecutor) - Constructor for class org.omegazero.common.event.DelegatingTaskQueueExecutor
-
Creates a new
DelegatingTaskQueueExecutor. - description() - Element in annotation interface org.omegazero.common.config.ConfigurationOption
-
A detailed description of this configuration option.
- deserialize(byte[]) - Static method in class org.omegazero.common.util.SerializationUtil
-
Deserializes the given object data using an
ObjectInputStream. - destroy() - Method in class org.omegazero.common.event.task.LambdaTask
-
Removes the reference to the handler passed in the constructor.
- dispatchEvent(Event, Object...) - Method in class org.omegazero.common.eventbus.EventBus
-
Dispatches the given event to all event bus subscribers listening for this event.
- dispatchEventRes(Event, Object...) - Method in class org.omegazero.common.eventbus.EventBus
-
The behavior of this method is equal to
EventBus.dispatchEvent(Event, Object...), except that this method also returns the return values of the listener methods, wrapped in anEventResultobject.
E
- emit(int, Object...) - Method in class org.omegazero.common.event.EventEmitter
-
Alias for
EventEmitter.runEvent(int, Object...). - emit(String, Object...) - Method in class org.omegazero.common.event.EventEmitter
-
Alias for
EventEmitter.runEvent(String, Object...). - ENABLE_INTERNAL_DEBUG - Static variable in class org.omegazero.common.logging.LoggerUtil
-
System property
org.omegazero.common.logging.internalDebug - ENABLE_ST_CLASS_SOURCE - Static variable in class org.omegazero.common.logging.StandardLogger
-
System property
org.omegazero.common.logging.stackTraces.classSource - ENABLE_ST_CLASS_SOURCE_FULL - Static variable in class org.omegazero.common.logging.StandardLogger
-
System property
org.omegazero.common.logging.stackTraces.classSourceFull - ENABLE_XST_VERBOSE - Static variable in class org.omegazero.common.logging.StandardLogger
-
System property
org.omegazero.common.logging.stackTraces.xstVerbose - entrySet() - Method in class org.omegazero.common.config.ConfigObject
-
Returns an unmodifiable set of all entries in this
ConfigObject. - equals(Object) - Method in class org.omegazero.common.config.ConfigArray
-
Determines whether the given object is equal to this
ConfigArray. - equals(Object) - Method in class org.omegazero.common.config.ConfigObject
-
Determines whether the given object is equal to this
ConfigObject. - equals(Object) - Method in class org.omegazero.common.logging.LoggerUtil.LUPermission
- error(Object...) - Method in interface org.omegazero.common.logging.Logger
-
Logs the given message at
LogLevel.ERROR. - ERROR - Enum constant in enum class org.omegazero.common.logging.LogLevel
-
Messages indicating unusual error conditions, possibly requiring user intervention.
- Event - Class in org.omegazero.common.eventbus
-
Primarily used for calling event bus subscribers using an
EventBus. - Event(String, boolean, Class<?>[], Class<?>, boolean) - Constructor for class org.omegazero.common.eventbus.Event
-
Creates a general-purpose
Eventobject. - Event(String, Class<?>[]) - Constructor for class org.omegazero.common.eventbus.Event
- Event(String, Class<?>[], Class<?>) - Constructor for class org.omegazero.common.eventbus.Event
- EventBus - Class in org.omegazero.common.eventbus
-
An
EventBusis used for dispatchingEvents to event bus subscribers which are listening for the specific event and registered in thisEventBus. - EventBus() - Constructor for class org.omegazero.common.eventbus.EventBus
- EventBusException - Exception Class in org.omegazero.common.eventbus
-
An exception thrown when an error occurs during execution of an
EventBussubscriber handler method. - EventBusException(String) - Constructor for exception class org.omegazero.common.eventbus.EventBusException
-
Creates a
EventBusExceptionwith the specified message. - EventBusException(String, Throwable) - Constructor for exception class org.omegazero.common.eventbus.EventBusException
-
Creates a
EventBusExceptionwith the specified message and cause. - EventBusSubscriber - Annotation Interface in org.omegazero.common.eventbus
-
Annotation required in classes registered as an
EventBussubscriber. - EventEmitter - Class in org.omegazero.common.event
-
Used for distributing and executing events among a set of registered listeners.
- EventEmitter() - Constructor for class org.omegazero.common.event.EventEmitter
- EventQueue - Class in org.omegazero.common.event
-
Deprecated.Since 2.6. Use
BlockingQueueand its implementing classes instead. - EventQueue() - Constructor for class org.omegazero.common.event.EventQueue
-
Deprecated.Creates a new event queue.
The default values are:
maxTasks: 65536
preallocate: false - EventQueue(int, boolean) - Constructor for class org.omegazero.common.event.EventQueue
-
Deprecated.Creates a new event queue.
- EventQueueExecutor - Class in org.omegazero.common.event
-
Deprecated.Since 2.6. Use a
TaskQueueExecutorwith aBlockingQueueinstead. - EventQueueExecutor() - Constructor for class org.omegazero.common.event.EventQueueExecutor
-
Deprecated.Default values:
maxThreads: Number of processors
daemon: true
threadName: "EventQueueExecutor" - EventQueueExecutor(boolean) - Constructor for class org.omegazero.common.event.EventQueueExecutor
-
Deprecated.Default values:
maxThreads: Number of processors
threadName: "EventQueueExecutor" - EventQueueExecutor(boolean, String) - Constructor for class org.omegazero.common.event.EventQueueExecutor
-
Deprecated.Default values:
maxThreads: Number of processors
threadName: "EventQueueExecutor" - EventQueueExecutor(int) - Constructor for class org.omegazero.common.event.EventQueueExecutor
-
Deprecated.Default values:
daemon: true
threadName: "EventQueueExecutor" - EventQueueExecutor(int, boolean) - Constructor for class org.omegazero.common.event.EventQueueExecutor
-
Deprecated.Default values:
threadName: "EventQueueExecutor" - EventQueueExecutor(int, boolean, String) - Constructor for class org.omegazero.common.event.EventQueueExecutor
-
Deprecated.Creates a new EventQueue with built-in executor threads that call
EventQueue.execute(). - EventQueueExecutor.WorkerThread - Class in org.omegazero.common.event
-
Deprecated.
- EventResult - Class in org.omegazero.common.eventbus
-
Contains result data of the execution of an
Event, returned byEventBus.dispatchEventRes(Event, Object...). - execute() - Method in class org.omegazero.common.event.EventQueue
-
Deprecated.Executes the
Taskwith the highest priority. - execute(Object[]) - Method in class org.omegazero.common.event.task.AbstractTask
-
Executes this task with the given arguments.
- execute(Object[]) - Method in class org.omegazero.common.event.task.LambdaTask
- execute(Object[]) - Method in class org.omegazero.common.event.task.ReflectTask
- execute(Object[]) - Method in class org.omegazero.common.event.task.RunnableTask
- executeBlocking() - Method in class org.omegazero.common.event.EventQueue
-
Deprecated.Blocks the thread until a task to execute becomes available, then executes it.
- ExecutionFailedException - Exception Class in org.omegazero.common.event.task
-
Exception thrown when a
Taskor other runnable failed to execute due to an exception. - ExecutionFailedException(String) - Constructor for exception class org.omegazero.common.event.task.ExecutionFailedException
-
Creates a new
ExecutionFailedExceptionwith the specified message. - ExecutionFailedException(String, Throwable) - Constructor for exception class org.omegazero.common.event.task.ExecutionFailedException
-
Creates a new
ExecutionFailedExceptionwith the specified message and cause. - ExecutionFailedException(Throwable) - Constructor for exception class org.omegazero.common.event.task.ExecutionFailedException
-
Creates a new
ExecutionFailedExceptionwith the specified cause. - exit() - Method in class org.omegazero.common.event.AbstractTaskQueueExecutor
-
Shuts this
AbstractTaskQueueExecutordown by gracefully stopping the worker threads. - exit() - Method in class org.omegazero.common.event.EventQueueExecutor
-
Deprecated.Default values:
blocking: false - exit() - Static method in class org.omegazero.common.event.Tasks
-
See
TaskScheduler.exit(). - exit() - Method in class org.omegazero.common.event.TaskScheduler
-
Equivalent to a call to:
- exit(boolean) - Method in class org.omegazero.common.event.AbstractTaskQueueExecutor
-
Shuts this
AbstractTaskQueueExecutordown by gracefully stopping the worker threads. - exit(boolean) - Method in class org.omegazero.common.event.DeferringTaskQueueExecutor
- exit(boolean) - Method in class org.omegazero.common.event.DelegatingTaskQueueExecutor
- exit(boolean) - Method in class org.omegazero.common.event.EventQueueExecutor
-
Deprecated.Notifies worker threads that executor is exiting, causing them to complete running all tasks.
- exit(boolean) - Method in class org.omegazero.common.event.SynchronousTaskQueueExecutor
-
Shuts this
AbstractTaskQueueExecutordown by gracefully stopping the worker threads. - exit(boolean) - Method in class org.omegazero.common.event.TaskQueueExecutor
-
Shuts this
TaskQueueExecutordown by interrupting all idle worker threads, causing them to exit. - exit(boolean) - Method in class org.omegazero.common.event.TaskScheduler
-
Exits this TaskScheduler by running any remaining tasks (also waiting for ones that are to be run in the future and non-daemon) and exiting the worker threads.
- EXIT_ON_ERROR - Static variable in class org.omegazero.common.plugins.PluginManager
-
Exit the method when an error occurs while loading a plugin, rethrowing the caught exception.
- ExtendedPluginConfiguration - Annotation Interface in org.omegazero.common.plugins
-
Annotation to declare the configuration method of a
Plugin.
F
- fatal(Object...) - Method in interface org.omegazero.common.logging.Logger
-
Logs the given message at
LogLevel.FATAL. - FATAL - Enum constant in enum class org.omegazero.common.logging.LogLevel
-
Messages requiring immediate user intervention, because the application is no longer functioning properly.
- FileLoggerOutput - Class in org.omegazero.common.logging
-
A
LoggerOutputwriting to a file. - FileLoggerOutput(String) - Constructor for class org.omegazero.common.logging.FileLoggerOutput
-
Creates a new
FileLoggerOutput, writing to the givenlogFile. - FileLoggerOutput(String, int, int) - Constructor for class org.omegazero.common.logging.FileLoggerOutput
-
Creates a new
FileLoggerOutput, writing to the givenlogFile. - findClass(String) - Method in class org.omegazero.common.plugins.PluginClassLoader
- flush() - Method in class org.omegazero.common.logging.FileLoggerOutput
- flush() - Method in interface org.omegazero.common.logging.LoggerOutput
-
Flushes any buffered data to the underlying output.
- flush() - Method in class org.omegazero.common.logging.LoggerOutputStream
- flush() - Method in class org.omegazero.common.logging.RotatingFileLoggerOutput
- flush() - Method in class org.omegazero.common.logging.StdStreamsLoggerOutput
- flushEventCache() - Method in class org.omegazero.common.eventbus.EventBus
-
Flushes the event cache for all events.
- flushLogBuffer() - Static method in class org.omegazero.common.logging.LoggerUtil
-
Calls
LoggerOutput.flush()on all configuredLoggerOutputs. - from(Queue<Task>) - Static method in class org.omegazero.common.event.TaskQueueExecutor
-
Creates a new
TaskQueueExecutor.Builderwith the given backing queue for theTaskQueueExecutor. - fromPriority() - Static method in class org.omegazero.common.event.TaskQueueExecutor
- fromSequential() - Static method in class org.omegazero.common.event.TaskQueueExecutor
G
- GenericRunnable - Interface in org.omegazero.common.event.runnable
-
Represents a runnable or method reference with any number of arguments with any type, allowed to throw any exception.
- GenericRunnable.A0 - Interface in org.omegazero.common.event.runnable
-
A
GenericRunnablewith 0 arguments. - GenericRunnable.A1<A> - Interface in org.omegazero.common.event.runnable
-
A
GenericRunnablewith 1 argument. - GenericRunnable.A2<A,
B> - Interface in org.omegazero.common.event.runnable -
A
GenericRunnablewith 2 arguments. - GenericRunnable.A3<A,
B, - Interface in org.omegazero.common.event.runnableC> -
A
GenericRunnablewith 3 arguments. - GenericRunnable.A4<A,
B, - Interface in org.omegazero.common.event.runnableC, D> -
A
GenericRunnablewith 4 arguments. - get() - Method in interface org.omegazero.common.util.function.SpecificThrowingSupplier
-
Creates a result.
- get(int) - Method in class org.omegazero.common.config.ConfigArray
-
Returns the element at the given position in this
ConfigArray. - get(String) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a value associated with the given key in this
ConfigObject, ornullif the given key has no value set. - get(String, Object...) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Combines
ReflectionUtil.getClass(String),ReflectionUtil.getField(String, Object), andReflectionUtil.callMethod(String, Object[])into a single method. - getActions() - Method in class org.omegazero.common.logging.LoggerUtil.LUPermission
- getAdditionalOption(String) - Method in class org.omegazero.common.plugins.Plugin
-
Returns the value of an unrecognized option in the metadata file.
- getArgumentCount() - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A0
- getArgumentCount() - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A1
- getArgumentCount() - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A2
- getArgumentCount() - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A3
- getArgumentCount() - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A4
- getArgumentCount() - Method in interface org.omegazero.common.event.runnable.GenericRunnable
-
Returns the number of arguments this
GenericRunnableaccepts. - getArray(String) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
ConfigArrayassociated with the given key in thisConfigObject. - getAttachment() - Method in class org.omegazero.common.logging.LoggerUtil.LUPermission
- getAttachment(String) - Method in interface org.omegazero.common.util.AttachmentContainer
-
Retrieves an attachment identified by the given key previously set by
AttachmentContainer.setAttachment(String, Object). - getAttachment(String) - Method in class org.omegazero.common.util.SimpleAttachmentContainer
- getBoolean(String) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
booleanassociated with the given key in thisConfigObject. - getBoolean(String, boolean) - Static method in class org.omegazero.common.util.PropertyUtil
-
Gets the system property value associated with the given key and attempts to parse it a boolean.
- getBoolean(Properties, String, boolean) - Static method in class org.omegazero.common.util.PropertyUtil
-
Gets the string associated with the given key in the
Propertiesobject and attempts to parse it a boolean. - getBooleanOrDefault(String, boolean) - Method in class org.omegazero.common.util.Args
-
Returns the boolean value identified by the given key, or def if no value with the specified key exists or is not a boolean.
- getCallerInstance() - Method in class org.omegazero.common.event.task.ReflectTask
-
Returns the callee instance passed in the constructor.
- getClass(String) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Returns the
Classobject for the given class name. - getClassesForSignature(String) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Returns the array of
Classobjects for a given type signature list. - getClassForTypeSignature(String) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Returns the
Classobject for a given type signature. - getDefaultEventListener(String) - Method in class org.omegazero.common.event.EventEmitter
-
Returns the default event listener of the given event
name. - getDelegate() - Method in class org.omegazero.common.event.DelegatingTaskQueueExecutor
-
Returns the currently set
AbstractTaskQueueExecutorto delegate tasks to. - getDescription() - Method in class org.omegazero.common.plugins.Plugin
-
Returns a description provided in the metadata file or
nullif none was provided. - getDouble(String) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
doubleassociated with the given key in thisConfigObject. - getDouble(String, double) - Static method in class org.omegazero.common.util.PropertyUtil
-
Gets the system property value associated with the given key and attempts to parse it as a double-precision floating point number.
- getDouble(Properties, String, double) - Static method in class org.omegazero.common.util.PropertyUtil
-
Gets the string associated with the given key in the
Propertiesobject and attempts to parse it as a double-precision floating point number. - getDoubleOrDefault(String, double) - Method in class org.omegazero.common.util.Args
-
Returns the double-precision floating-point number value identified by the given key, or def if no value with the specified key exists or is not a number.
- getEventListenerCount(String) - Method in class org.omegazero.common.event.EventEmitter
-
Returns the number of event listeners registered for the given event
name, excluding the default listener. - getEventListeners(String) - Method in class org.omegazero.common.event.EventEmitter
-
Returns an unmodifiable, possibly empty, list of the event listeners registered for the given event
name, excluding the default listener. - getEventNames() - Method in class org.omegazero.common.event.EventEmitter
-
Returns an unmodifiable set of known event names.
- getEventSignature() - Method in class org.omegazero.common.eventbus.Event
-
Returns a string containing the method name and a string representation of method parameters and the return type of the target event method.
- getField(String, Object) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Reads the field identified by the given identifier, which has the format "
<full class name>#<field name>". - getFieldOptional(String, Object) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Reads the field identified by the given identifier.
- getFloat(String) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
floatassociated with the given key in thisConfigObject. - getFloat(String, float) - Static method in class org.omegazero.common.util.PropertyUtil
-
Gets the system property value associated with the given key and attempts to parse it as a floating point number.
- getFloat(Properties, String, float) - Static method in class org.omegazero.common.util.PropertyUtil
-
Gets the string associated with the given key in the
Propertiesobject and attempts to parse it as a floating point number. - getFloatOrDefault(String, float) - Method in class org.omegazero.common.util.Args
-
Returns the single-precision floating-point number value identified by the given key, or def if no value with the specified key exists or is not a number.
- getForcedEvents() - Method in class org.omegazero.common.eventbus.Subscriber
-
Returns the array of event method names the subscriber has declared itself as listening to.
- getFormattedTime() - Static method in class org.omegazero.common.util.Util
-
Formats the current time in this format:
(weekday) (month) DD YYYY HH:MM:SS.mmm
where(weekday)is the three-letter shortened name of the current weekday (Mon,Tue, etc) and(month)the three-letter shortened name of the current month (Jan,Feb, etc). - getFullClassName() - Method in class org.omegazero.common.logging.StandardLogger
-
Returns the full name of the class this
StandardLoggeris bound to. - getId() - Method in class org.omegazero.common.event.TaskScheduler.TimerTask
-
Returns the
TaskScheduler-instance-wide unique ID of thisTaskScheduler.TimerTask. - getId() - Method in class org.omegazero.common.plugins.Plugin
-
The plugin ID is a string given in the plugin metadata file consisting only of upper- or lowercase letters and numbers.
- getInstance() - Method in class org.omegazero.common.eventbus.Subscriber
-
Returns the event bus subscriber instance this
Subscriberwraps. - getInt(String) - Method in class org.omegazero.common.config.ConfigObject
-
Returns an
intassociated with the given key in thisConfigObject. - getInt(String, int) - Static method in class org.omegazero.common.util.PropertyUtil
-
Gets the system property value associated with the given key and attempts to parse it as an integer.
- getInt(Properties, String, int) - Static method in class org.omegazero.common.util.PropertyUtil
-
Gets the string associated with the given key in the
Propertiesobject and attempts to parse it as an integer. - getIntegerFieldNames(Class<?>, String, int, int, boolean) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Gets the names of all
public static int(possibly alsofinal) fields starting with prefix of the given class. - getIntOrDefault(String, int) - Method in class org.omegazero.common.util.Args
-
Returns the integer value identified by the given key, or def if no value with the specified key exists or is not a number.
- getLabel() - Method in interface org.omegazero.common.logging.Logger
-
Returns the label used to identify this
Loggerin log messages. - getLabel() - Method in class org.omegazero.common.logging.StandardLogger
-
Returns the label used to identify this
Loggerin log messages. - getListenerMethod(String, Class<?>[], Class<?>) - Method in class org.omegazero.common.eventbus.Subscriber
-
Searches the valid event listener method with the given name and parameterTypes.
- getListenerMethodForEvent(Event) - Method in class org.omegazero.common.eventbus.Subscriber
-
Searches the valid event listener method suitable for the given event.
- getListeners() - Method in class org.omegazero.common.eventbus.EventResult
-
Returns the number of event handlers that were executed.
- getLogFile() - Method in class org.omegazero.common.logging.FileLoggerOutput
-
Returns the file name log messages are written to.
- getLogFile() - Static method in class org.omegazero.common.logging.LoggerUtil
-
Deprecated.Since 2.10, use
insteadgetLoggerOutputByType(FileLoggerOutput.class).getLogFile() - getLoggerOutputByType(Class<T>) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Returns a configured
LoggerOutputwith the given type or a subtype thereof. - getLoggerOutputsByType(Class<T>) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Returns all configured
LoggerOutputs with the given type or a subtype thereof. - getLogLevel() - Static method in class org.omegazero.common.logging.LoggerUtil
-
Returns the current log level.
- getLong(String) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
longassociated with the given key in thisConfigObject. - getLong(String, long) - Static method in class org.omegazero.common.util.PropertyUtil
-
Gets the system property value associated with the given key and attempts to parse it as a long integer.
- getLong(Properties, String, long) - Static method in class org.omegazero.common.util.PropertyUtil
-
Gets the string associated with the given key in the
Propertiesobject and attempts to parse it as a long integer. - getLongOrDefault(String, long) - Method in class org.omegazero.common.util.Args
-
Returns the long integer value identified by the given key, or def if no value with the specified key exists or is not a number.
- getMainClassInstance() - Method in class org.omegazero.common.plugins.Plugin
-
Returns the instance of the main class of this
Plugin. - getMainClassType() - Method in class org.omegazero.common.plugins.Plugin
-
Returns the type of the main class of this
Plugin, loaded by the class loader passed in the constructor. - getMaxThreads() - Method in class org.omegazero.common.event.EventQueueExecutor
-
Deprecated.
- getMaxWorkerThreadCount() - Method in class org.omegazero.common.event.TaskQueueExecutor
-
Returns the configured maximum number of worker threads.
- getMethod() - Method in class org.omegazero.common.event.task.ReflectTask
-
Returns the task method passed in the constructor.
- getMethodName() - Method in class org.omegazero.common.eventbus.Event
-
Returns the method name of this event, which is the name of the method that is called when this event occurs.
- getMethodSignature(Class<?>, Class<?>[]) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Returns the method type signature of a method with the given returnType and parameterTypes.
- getMethodSignature(Method) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Returns the method type signature of the given
Method. - getName() - Method in class org.omegazero.common.plugins.Plugin
-
Returns the name of this plugin.
- getNextTask() - Method in class org.omegazero.common.event.EventQueue
-
Deprecated.
- getObject(String) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
ConfigObjectassociated with the given key in thisConfigObject. - getOptional(String, Object...) - Static method in class org.omegazero.common.util.ReflectionUtil
-
The same as
ReflectionUtil.get(String, Object[]), except that an emptyOptionalis returned if an exception is thrown. - getParams() - Method in class org.omegazero.common.eventbus.Event
-
Returns the method parameters of the target method of this event.
- getPeriod() - Method in class org.omegazero.common.event.TaskScheduler.TimerTask
-
Returns the interval in nanoseconds between running this task.
- getPriority() - Method in class org.omegazero.common.event.task.AbstractTask
- getPriority() - Method in interface org.omegazero.common.event.task.Task
-
Returns the priority of this task.
- getQueuedTaskCount() - Method in class org.omegazero.common.event.EventQueue
-
Deprecated.
- getQueuedTaskCount() - Method in class org.omegazero.common.event.TaskQueueExecutor
-
Returns the number of queued tasks.
- getReturnType() - Method in class org.omegazero.common.eventbus.Event
-
Returns the return type of the target method of this event.
- getReturnValue() - Method in class org.omegazero.common.eventbus.EventResult
-
Returns the single return value of the event execution.
- getReturnValues() - Method in class org.omegazero.common.eventbus.EventResult
-
Returns the list of all collected return values, excluding
null. - getSignatureOfClass(Class<?>) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Returns the type signature string of the given type, for example "
I" or "Ljava/lang/String;". - getString(String) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
Stringassociated with the given key in thisConfigObject. - getString(String, String) - Static method in class org.omegazero.common.util.PropertyUtil
-
Returns the system property value associated with the given key.
- getString(Properties, String, String) - Static method in class org.omegazero.common.util.PropertyUtil
-
Returns the string associated with the given key in the
Propertiesobject. - getSubscriberCount() - Method in class org.omegazero.common.eventbus.EventBus
-
Returns the number of registered event bus subscribers.
- getTime() - Method in class org.omegazero.common.event.TaskScheduler.TimerTask
-
Returns the absolute time in nanoseconds when this task is scheduled to run.
- getType() - Method in class org.omegazero.common.eventbus.Subscriber
-
Returns the class of the event bus subscriber instance this
Subscriberwraps. - getTypesFromObjectArray(Object[]) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Returns an array containing the types of each object in the given array.
- getValue(String) - Method in class org.omegazero.common.util.Args
-
Returns the string value identified by the given key, or
nullif no value with the specified key exists. - getValueOrDefault(String, String) - Method in class org.omegazero.common.util.Args
-
Returns the string value identified by the given key, or def if no value with the specified key exists.
- getVersion() - Static method in class org.omegazero.common.OmzLib
-
Returns the version string.
- getVersion() - Method in class org.omegazero.common.plugins.Plugin
-
Returns the version string set in the metadata file or
nullif none was set. - getWorkerThreadCount() - Method in class org.omegazero.common.event.EventQueueExecutor
-
Deprecated.
- getWorkerThreadCount() - Method in class org.omegazero.common.event.TaskQueueExecutor
-
Returns the current number of worker threads.
H
- hasAttachment(String) - Method in interface org.omegazero.common.util.AttachmentContainer
-
Determines whether an attachment identified by the given key exists.
- hasAttachment(String) - Method in class org.omegazero.common.util.SimpleAttachmentContainer
- hashCode() - Method in class org.omegazero.common.config.ConfigArray
-
Returns a hash code for this
ConfigArray. - hashCode() - Method in class org.omegazero.common.config.ConfigObject
-
Returns a hash code for this
ConfigObject. - hashCode() - Method in class org.omegazero.common.logging.LoggerUtil.LUPermission
- HIGH - Enum constant in enum class org.omegazero.common.eventbus.SubscribeEvent.Priority
-
Priority value between
NORMALandHIGHEST. - HIGHEST - Enum constant in enum class org.omegazero.common.eventbus.SubscribeEvent.Priority
-
The highest possible priority value.
I
- I - Static variable in class org.omegazero.common.event.Tasks
-
The
TaskSchedulerinstance. - implies(Permission) - Method in class org.omegazero.common.logging.LoggerUtil.LUPermission
- indexOf(byte[], byte) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
byteb in the given array. - indexOf(byte[], byte[]) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches for the sequence of bytes in the larger byte array.
- indexOf(byte[], byte[], int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches for the sequence of bytes in the larger byte array, starting at offset.
- indexOf(byte[], byte, int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
byteb in the given array, starting at offset and continuing for a maximum of length elements. - indexOf(char[], char) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
charc in the given array. - indexOf(char[], char, int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
charc in the given array, starting at offset and continuing for a maximum of length elements. - indexOf(double[], double) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
doubled in the given array. - indexOf(double[], double, int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
doubled in the given array, starting at offset and continuing for a maximum of length elements. - indexOf(float[], float) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
floatf in the given array. - indexOf(float[], float, int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
floatf in the given array, starting at offset and continuing for a maximum of length elements. - indexOf(int[], int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
inti in the given array. - indexOf(int[], int, int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
inti in the given array, starting at offset and continuing for a maximum of length elements. - indexOf(long[], long) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
longl in the given array. - indexOf(long[], long, int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
longl in the given array, starting at offset and continuing for a maximum of length elements. - indexOf(short[], short) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
shorts in the given array. - indexOf(short[], short, int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given
shorts in the given array, starting at offset and continuing for a maximum of length elements. - indexOf(Object) - Method in class org.omegazero.common.config.ConfigArray
-
Returns the index of the given element.
- indexOf(T[], T) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given element e in the given array.
- indexOf(T[], T, int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Searches the given element e in the given array, starting at offset and continuing for a maximum of length elements.
- info(Object...) - Method in interface org.omegazero.common.logging.Logger
-
Logs the given message at
LogLevel.INFO. - INFO - Enum constant in enum class org.omegazero.common.logging.LogLevel
-
Information messages, relevant for application users.
- init() - Static method in class org.omegazero.common.logging.LoggerUtil
-
Initializes the logger library, setting the log level to
LogLevel.INFO. - init() - Method in class org.omegazero.common.plugins.Plugin
-
Loads the metadata file and main class of this
Plugin. - init(Supplier<Application>) - Static method in class org.omegazero.common.runtime.ApplicationWrapper
-
Initializes the
ApplicationWrapperby setting theApplicationinstance from the given supplier. - init(LogLevel, String) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Initializes the logger library, setting the maximum log level to level and the log file name, where log messages will be saved to.
- init(Application) - Static method in class org.omegazero.common.runtime.ApplicationWrapper
-
Initializes the
ApplicationWrapperby setting theApplicationinstance. - init(Application, Supplier<Args>) - Static method in class org.omegazero.common.runtime.ApplicationWrapper
-
Initializes the
ApplicationWrapperby setting theApplicationinstance and an optional customArgsparser. - initPluginConfig(ConfigObject) - Method in class org.omegazero.common.plugins.Plugin
-
Applies the given
configdata to this plugin's object. - interval(Runnable, long) - Static method in class org.omegazero.common.event.Tasks
-
Deprecated.Since 2.9.1, use
Tasks.I - interval(Runnable, long) - Method in class org.omegazero.common.event.TaskScheduler
-
Schedules a task to be run every interval milliseconds.
- interval(Consumer<Object[]>, long, Object...) - Static method in class org.omegazero.common.event.Tasks
-
Deprecated.Since 2.9.1, use
Tasks.I - interval(Consumer<Object[]>, long, Object...) - Method in class org.omegazero.common.event.TaskScheduler
-
Schedules a task to be run every interval milliseconds.
- InvalidPluginException - Exception Class in org.omegazero.common.plugins
-
An exception thrown to indicate a
Pluginis invalid. - InvalidPluginException(String, String) - Constructor for exception class org.omegazero.common.plugins.InvalidPluginException
- InvalidPluginException(String, String, Throwable) - Constructor for exception class org.omegazero.common.plugins.InvalidPluginException
- isAllDaemon() - Method in class org.omegazero.common.event.TaskScheduler
-
Returns
trueif all queued tasks are marked as daemon usingTaskScheduler.TimerTask.daemon()or if there are no queued tasks. - isCancelable() - Method in class org.omegazero.common.eventbus.Event
-
Whether this event was configured to allow cancellation using
Event.cancel(). - isCanceled() - Method in class org.omegazero.common.event.TaskScheduler.TimerTask
-
Returns
trueif this task is canceled. - isCanceled() - Method in class org.omegazero.common.eventbus.Event
-
Returns
trueif this event was canceled. - isDaemon() - Method in class org.omegazero.common.event.TaskScheduler.TimerTask
-
Returns
trueif this task was defined as a daemon task. - isEmpty() - Method in class org.omegazero.common.config.ConfigArray
-
Returns whether this
ConfigArrayis empty. - isEmpty() - Method in class org.omegazero.common.config.ConfigObject
-
Returns
trueif thisConfigObjectcontains no key-value pairs. - isEventRegistered(String) - Method in class org.omegazero.common.event.EventEmitter
-
Returns
trueif the given eventnameis a known event. - isForcedEvent(Event) - Method in class org.omegazero.common.eventbus.Subscriber
-
Checks if this
Subscriberhas explicitly declared itself as listening to the given event usingSubscriber.setForcedEvents(String[]). - isIncludeAllReturns() - Method in class org.omegazero.common.eventbus.Event
-
Whether all event bus subscriber handlers should be called to collect a list of return values when dispatching this event.
- isListenerMethodForEventAvailable(Event) - Method in class org.omegazero.common.eventbus.Subscriber
-
Checks if there is a valid listener method available at this event bus subscriber.
- isLoggerMuted(String) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Returns whether the logger with the given name is muted due to a previous call to
LoggerUtil.muteLogger(String) - isLogging(LogLevel) - Method in interface org.omegazero.common.logging.Logger
-
Checks if this
Loggerprints log messages, taking into account the configured log level and other logger settings. - isLogging(LogLevel) - Method in class org.omegazero.common.logging.StandardLogger
- isMethod(Method, String, Class<?>[]) - Static method in class org.omegazero.common.util.ReflectionUtil
-
Checks whether the given method has the given name and parameterTypes.
- isPropertySet(String) - Static method in class org.omegazero.common.util.PropertyUtil
-
Returns whether the system property identified by the given key is set.
- isQueueEmpty() - Method in class org.omegazero.common.event.TaskQueueExecutor
-
Returns
trueif the queue is empty. - isShuttingDown() - Static method in class org.omegazero.common.runtime.ApplicationWrapper
-
Returns whether the runtime is shutting down (
ApplicationWrapper.shutdown()was called). - isStateful() - Method in class org.omegazero.common.eventbus.Event
-
Returns true if this event has a variable state.
- isTaskQueued() - Method in class org.omegazero.common.event.EventQueue
-
Deprecated.
- isValidListenerMethod(Method) - Method in class org.omegazero.common.eventbus.Subscriber
-
Returns
trueif the given method m is a valid event listener method. - iterator() - Method in class org.omegazero.common.config.ConfigArray
- iterator() - Method in class org.omegazero.common.plugins.PluginManager
J
- JSONConfiguration - Class in org.omegazero.common.config
-
A
Configurationimplementation based on JSON. - JSONConfiguration(byte[]) - Constructor for class org.omegazero.common.config.JSONConfiguration
-
Creates a new
JSONConfiguration. - JSONConfiguration(String) - Constructor for class org.omegazero.common.config.JSONConfiguration
-
Creates a new
JSONConfiguration.
K
- keySet() - Method in class org.omegazero.common.config.ConfigObject
-
Returns an unmodifiable set of all keys of this
ConfigObject.
L
- LambdaTask - Class in org.omegazero.common.event.task
- LambdaTask(Consumer<Object[]>, Object[]) - Constructor for class org.omegazero.common.event.task.LambdaTask
-
Creates a new
LambdaTask. - LambdaTask(Consumer<Object[]>, Object[], int) - Constructor for class org.omegazero.common.event.task.LambdaTask
-
Creates a new
LambdaTask. - lastIndexOf(Object) - Method in class org.omegazero.common.config.ConfigArray
-
Returns the last index of the given element.
- level() - Method in enum class org.omegazero.common.logging.LogLevel
-
Returns an integer representation of a log level, starting with 0 being the lowest log level (
LogLevel.FATAL). - load() - Method in interface org.omegazero.common.config.Configuration
-
Loads this configuration.
- load() - Method in class org.omegazero.common.config.JSONConfiguration
-
Loads this configuration.
- loadClass(String) - Method in class org.omegazero.common.plugins.Plugin
-
Loads the file in this
Plugin's root identified by the given path and stores its data and additional information in the returnedLoadedClassFile. - LoadedClassFile(byte[], Manifest, CodeSource) - Constructor for class org.omegazero.common.plugins.Plugin.LoadedClassFile
- loadFile(String) - Method in class org.omegazero.common.plugins.Plugin
-
Loads the file in this
Plugin's root identified by the given path. - loadFromDirectory(String, int) - Method in class org.omegazero.common.plugins.PluginManager
-
Loads plugins from the given directory.
- loadFromDirectory(Path, int) - Method in class org.omegazero.common.plugins.PluginManager
-
Searches for plugins in the given directory and loads them using
PluginManager.loadPlugin(Path). - loadFromJar(Path, String, int) - Method in class org.omegazero.common.plugins.PluginManager
-
Searches for plugins in the JAR file at the given path, by attempting to load any nested JAR files, whose relative path in the given JAR file start with innerPath.
- loadFromPath(String, int) - Method in class org.omegazero.common.plugins.PluginManager
-
Searches for plugins at the given path.
- loadPlugin(Path) - Method in class org.omegazero.common.plugins.PluginManager
-
Loads and initializes the plugin at path and registers it with this
PluginManagerinstance. - lock() - Method in class org.omegazero.common.event.DelegatingTaskQueueExecutor
-
Locks this
DelegatingTaskQueueExecutor. - log(LogLevel, Object...) - Method in interface org.omegazero.common.logging.Logger
-
Constructs a log message from the given objects and outputs it at the given log level.
- log(LogLevel, Object...) - Method in class org.omegazero.common.logging.StandardLogger
- LOG_BUFFER_BYTES - Static variable in class org.omegazero.common.logging.FileLoggerOutput
-
System property
org.omegazero.common.logging.logBufferSize - Logger - Interface in org.omegazero.common.logging
-
A class used for outputting application messages.
- LoggerOutput - Interface in org.omegazero.common.logging
-
Represents a location where log messages generated by
StandardLoggers are written to. - LoggerOutputStream - Class in org.omegazero.common.logging
- LoggerOutputStream(Logger, LogLevel) - Constructor for class org.omegazero.common.logging.LoggerOutputStream
-
Creates a
LoggerOutputStreamwith the givenLoggerinstance and outputLogLevel. - LoggerUtil - Class in org.omegazero.common.logging
-
Maintains and manages the logging state of omz-java-lib and
Loggerinstances. - LoggerUtil.LUPermission - Class in org.omegazero.common.logging
-
Represents a permission checked by the security manager when an operation is performed that changes the logging state.
- LogLevel - Enum Class in org.omegazero.common.logging
-
Represents the importance level of a log message created by a
Logger. - logToListeners(LogLevel, String) - Static method in class org.omegazero.common.logging.LoggerUtil
- LOW - Enum constant in enum class org.omegazero.common.eventbus.SubscribeEvent.Priority
-
Priority value between
LOWESTandNORMAL. - LOWEST - Enum constant in enum class org.omegazero.common.eventbus.SubscribeEvent.Priority
-
The lowest possible priority value.
- LUPermission(String, String, Object) - Constructor for class org.omegazero.common.logging.LoggerUtil.LUPermission
M
- manifest - Variable in class org.omegazero.common.plugins.Plugin.LoadedClassFile
- MAX_FILE_SIZE_DEFAULT - Static variable in class org.omegazero.common.logging.RotatingFileLoggerOutput
-
System property
org.omegazero.common.logging.rotation.maxFileSize - merge(ConfigArray) - Method in class org.omegazero.common.config.ConfigArray
-
Creates a new
ConfigArraythat contains all values of this and the givenConfigArray. - merge(ConfigObject) - Method in class org.omegazero.common.config.ConfigObject
-
Creates a new
ConfigObjectthat contains all properties of this and the givenConfigObject. - muteLogger(String) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Mutes the
StandardLoggerwith the given name, causing the affected logger to no longer print log messages.
N
- name(String) - Method in class org.omegazero.common.event.TaskQueueExecutor.Builder
-
Sets worker thread name prefix for the
TaskQueueExecutor. - needAllLogMessages() - Static method in class org.omegazero.common.logging.LoggerUtil
- newHandle() - Method in class org.omegazero.common.event.TaskQueueExecutor
-
Creates a new
TaskQueueExecutor.Handlefor use inTaskQueueExecutor.queue(Task, Handle). - newLogMessage(String, String) - Static method in class org.omegazero.common.logging.LoggerUtil
- nonDaemonThreadRunning() - Static method in class org.omegazero.common.util.Util
-
Checks if there is at least one non-daemon thread running.
The caller thread and the "DestroyJavaVM" thread are excluded from this check. - NORMAL - Enum constant in enum class org.omegazero.common.eventbus.SubscribeEvent.Priority
-
The default priority.
O
- off(String, GenericRunnable) - Method in class org.omegazero.common.event.EventEmitter
- OmzLib - Class in org.omegazero.common
-
This class contains metadata about omz-java-lib (for example the version string).
- OmzLib() - Constructor for class org.omegazero.common.OmzLib
- on(String, GenericRunnable) - Method in class org.omegazero.common.event.EventEmitter
- on(String, GenericRunnable.A0) - Method in class org.omegazero.common.event.EventEmitter
-
Alias for
EventEmitter.addEventListener(String, GenericRunnable)for zero-argument events. - on(String, GenericRunnable.A1<?>) - Method in class org.omegazero.common.event.EventEmitter
-
Alias for
EventEmitter.addEventListener(String, GenericRunnable)for single-argument events. - on(String, GenericRunnable.A2<?, ?>) - Method in class org.omegazero.common.event.EventEmitter
-
Alias for
EventEmitter.addEventListener(String, GenericRunnable)for two-argument events. - on(String, GenericRunnable.A3<?, ?, ?>) - Method in class org.omegazero.common.event.EventEmitter
-
Alias for
EventEmitter.addEventListener(String, GenericRunnable)for three-argument events. - on(String, GenericRunnable.A4<?, ?, ?, ?>) - Method in class org.omegazero.common.event.EventEmitter
-
Alias for
EventEmitter.addEventListener(String, GenericRunnable)for four-argument events. - once(String, GenericRunnable) - Method in class org.omegazero.common.event.EventEmitter
- once(String, GenericRunnable.A0) - Method in class org.omegazero.common.event.EventEmitter
-
Alias for
EventEmitter.addEventListenerOnce(String, GenericRunnable)for zero-argument events. - once(String, GenericRunnable.A1<?>) - Method in class org.omegazero.common.event.EventEmitter
-
Alias for
EventEmitter.addEventListenerOnce(String, GenericRunnable)for single-argument events. - once(String, GenericRunnable.A2<?, ?>) - Method in class org.omegazero.common.event.EventEmitter
-
Alias for
EventEmitter.addEventListenerOnce(String, GenericRunnable)for two-argument events. - once(String, GenericRunnable.A3<?, ?, ?>) - Method in class org.omegazero.common.event.EventEmitter
-
Alias for
EventEmitter.addEventListenerOnce(String, GenericRunnable)for three-argument events. - once(String, GenericRunnable.A4<?, ?, ?, ?>) - Method in class org.omegazero.common.event.EventEmitter
-
Alias for
EventEmitter.addEventListenerOnce(String, GenericRunnable)for four-argument events. - onClose(Runnable) - Static method in class org.omegazero.common.util.Util
-
Adds a shutdown hook which runs the given
Runnable. - onClose(Runnable, boolean) - Static method in class org.omegazero.common.util.Util
-
Adds a shutdown hook which runs the given
Runnable. - optArray(String) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
ConfigArrayassociated with the given key in thisConfigObject, ornullif no mapping the the given key exists or is not aConfigArray. - optBoolean(String, boolean) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
booleanassociated with the given key in thisConfigObject, or def if no mapping the the given key exists or is not aboolean. - optDouble(String, double) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
doubleassociated with the given key in thisConfigObject, or def if no mapping the the given key exists or is not adouble. - optFloat(String, float) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
floatassociated with the given key in thisConfigObject, or def if no mapping the the given key exists or is not afloat. - optInt(String, int) - Method in class org.omegazero.common.config.ConfigObject
-
Returns an
intassociated with the given key in thisConfigObject, or def if no mapping the the given key exists or is not anint. - optLong(String, long) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
longassociated with the given key in thisConfigObject, or def if no mapping the the given key exists or is not along. - optObject(String) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
ConfigObjectassociated with the given key in thisConfigObject, ornullif no mapping the the given key exists or is not aConfigObject. - optString(String, String) - Method in class org.omegazero.common.config.ConfigObject
-
Returns a
Stringassociated with the given key in thisConfigObject, or def if no mapping the the given key exists or is not aString. - org.omegazero.common - package org.omegazero.common
-
Base package of the omegazero Java common library.
- org.omegazero.common.config - package org.omegazero.common.config
-
Provides configuration file and data manipulation classes.
- org.omegazero.common.event - package org.omegazero.common.event
-
Provides classes for scheduling asynchronous/concurrent tasks.
- org.omegazero.common.event.runnable - package org.omegazero.common.event.runnable
- org.omegazero.common.event.task - package org.omegazero.common.event.task
- org.omegazero.common.eventbus - package org.omegazero.common.eventbus
-
Provides an event bus for dispatching events to registered event listeners.
- org.omegazero.common.logging - package org.omegazero.common.logging
-
Provides a logging API.
- org.omegazero.common.plugins - package org.omegazero.common.plugins
-
Provides classes for managing plugins in an application.
- org.omegazero.common.runtime - package org.omegazero.common.runtime
-
Provides classes for application runtime management.
- org.omegazero.common.util - package org.omegazero.common.util
-
Contains miscellaneous utility classes.
- org.omegazero.common.util.function - package org.omegazero.common.util.function
-
Contains functional interfaces.
P
- parse(String[]) - Static method in class org.omegazero.common.util.Args
-
Parses the given array of arguments using the default format.
- parseArguments(String[]) - Method in class org.omegazero.common.util.Args.DefaultFormat
-
Parses the given argument array and stores the data in this
Argsobject. - parseArguments(String[]) - Method in class org.omegazero.common.util.Args
-
Parses the given argument array and stores the data in this
Argsobject. - Plugin - Class in org.omegazero.common.plugins
-
Represents a plugin managed by a
PluginManager. - Plugin(String, PluginClassLoader) - Constructor for class org.omegazero.common.plugins.Plugin
- Plugin.LoadedClassFile - Class in org.omegazero.common.plugins
-
Represents a loaded file with an optional
ManifestandCodeSource. - PluginClassLoader - Class in org.omegazero.common.plugins
-
The class loader for
Plugins. - PluginClassLoader() - Constructor for class org.omegazero.common.plugins.PluginClassLoader
- pluginCount() - Method in class org.omegazero.common.plugins.PluginManager
-
Returns the number of plugins registered in this
PluginManager. - PluginManager - Class in org.omegazero.common.plugins
-
Manages and loads
Plugins. - PluginManager() - Constructor for class org.omegazero.common.plugins.PluginManager
- populateConfigurationOptions(Object) - Method in class org.omegazero.common.config.ConfigObject
-
Populates all fields with the
ConfigurationOptionannotation of the giventargetObjectwith values from thisConfigObjectusing reflection. - prependEventListener(String, GenericRunnable) - Method in class org.omegazero.common.event.EventEmitter
-
Registers the given event listener for the given event
name. - printBrand() - Static method in class org.omegazero.common.OmzLib
-
Prints the version string and configured log level using a
Loggerfrom the logging library. - printStackTrace(Throwable, Consumer<String>) - Static method in class org.omegazero.common.logging.StandardLogger
-
Prints a stack trace of the given
throwableto the givenConsumer. - priority() - Element in annotation interface org.omegazero.common.eventbus.SubscribeEvent
-
An optional priority parameter.
- priorityNum() - Element in annotation interface org.omegazero.common.eventbus.SubscribeEvent
-
An alternative numeric value for the priority parameter.
- PropertyUtil - Class in org.omegazero.common.util
-
Contains utility methods for reading
Propertiesand system properties. - put(String, String) - Method in class org.omegazero.common.util.Args
-
Stores the given value identified by the key in this object.
Q
- queue(Method, Object, int, Object...) - Method in class org.omegazero.common.event.AbstractTaskQueueExecutor
-
Creates a new
ReflectTaskinstance and adds it to the event queue usingAbstractTaskQueueExecutor.queue(Task). - queue(Method, Object, int, Object...) - Method in class org.omegazero.common.event.EventQueue
-
Deprecated.Creates a new
ReflectTaskinstance and adds it to the event queue usingEventQueue.queue(Task). - queue(Method, Object, int, Object...) - Method in class org.omegazero.common.event.TaskQueueExecutor.Handle
-
Equivalent to
AbstractTaskQueueExecutor.queue(Method, Object, int, Object...), but queued with this handle. - queue(Runnable, int) - Method in class org.omegazero.common.event.AbstractTaskQueueExecutor
-
Creates a new
RunnableTaskinstance and adds it to the event queue usingAbstractTaskQueueExecutor.queue(Task). - queue(Runnable, int) - Method in class org.omegazero.common.event.TaskQueueExecutor.Handle
-
Equivalent to
AbstractTaskQueueExecutor.queue(Runnable, int), but queued with this handle. - queue(Consumer<Object[]>, int, Object...) - Method in class org.omegazero.common.event.AbstractTaskQueueExecutor
-
Creates a new
LambdaTaskinstance and adds it to the event queue usingAbstractTaskQueueExecutor.queue(Task). - queue(Consumer<Object[]>, int, Object...) - Method in class org.omegazero.common.event.EventQueue
-
Deprecated.Creates a new
LambdaTaskinstance and adds it to the event queue usingEventQueue.queue(Task). - queue(Consumer<Object[]>, int, Object...) - Method in class org.omegazero.common.event.TaskQueueExecutor.Handle
-
Equivalent to
AbstractTaskQueueExecutor.queue(Consumer, int, Object...), but queued with this handle. - queue(Task) - Method in class org.omegazero.common.event.AbstractTaskQueueExecutor
-
Queues a task to be executed by any available worker thread.
- queue(Task) - Method in class org.omegazero.common.event.DeferringTaskQueueExecutor
- queue(Task) - Method in class org.omegazero.common.event.DelegatingTaskQueueExecutor
- queue(Task) - Method in class org.omegazero.common.event.EventQueue
-
Deprecated.Queues a task to be executed in a subsequent
EventQueue.execute()call. - queue(Task) - Method in class org.omegazero.common.event.EventQueueExecutor
-
Deprecated.
- queue(Task) - Method in class org.omegazero.common.event.SynchronousTaskQueueExecutor
- queue(Task) - Method in class org.omegazero.common.event.TaskQueueExecutor.Handle
-
Queues the given
Taskwith this handle. - queue(Task) - Method in class org.omegazero.common.event.TaskQueueExecutor
-
Queues a task to be executed by any available worker thread.
- queue(Task, TaskQueueExecutor.Handle) - Method in class org.omegazero.common.event.TaskQueueExecutor
-
Queues a task to be executed by an available worker thread.
R
- randomHex(int) - Static method in class org.omegazero.common.util.Util
-
Creates a string of the given length containing characters chosen pseudo-randomly from the set of characters used for hexadecimal encoding (
0 - 9anda - f). - readInputStreamToByteArray(InputStream) - Static method in class org.omegazero.common.util.ArrayUtil
-
Reads all remaining data from the input stream (is) until end-of-file is reached, the VM runs out of memory or the maximum array size is reached.
- readInputStreamToByteArray(InputStream, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Reads all remaining data from the input stream (is) until end-of-file is reached or the amount of bytes read exceeds the limit.
- RECURSIVE - Static variable in class org.omegazero.common.plugins.PluginManager
-
Search for additional plugins in subdirectories.
- redirectStandardOutputStreams() - Static method in class org.omegazero.common.logging.LoggerUtil
-
Redirects the
System.outandSystem.errto Logger streams, causing messages printed usingSystem.out.[...]orSystem.err.[...]to be formatted to standard logger format and printed with log levelLogLevel.INFO. - ReflectionUtil - Class in org.omegazero.common.util
-
Contains utility methods for use with reflection.
- ReflectTask - Class in org.omegazero.common.event.task
-
A
Taskbased on reflection. - ReflectTask(Method, Object, Object[]) - Constructor for class org.omegazero.common.event.task.ReflectTask
-
Creates a new
ReflectTask. - ReflectTask(Method, Object, Object[], int) - Constructor for class org.omegazero.common.event.task.ReflectTask
-
Creates a new
ReflectTask. - register(Class<?>, Object, String...) - Method in class org.omegazero.common.eventbus.EventBus
-
Adds the instance of type type to the list of listeners receiving events from the event bus.
- register(Class<?>, String...) - Method in class org.omegazero.common.eventbus.EventBus
-
Adds a listener for type type to the list of listeners receiving events from the event bus.
- register(Object, String...) - Method in class org.omegazero.common.eventbus.EventBus
-
Adds the instance to the list of listeners receiving events from the event bus.
- register(Subscriber, String...) - Method in class org.omegazero.common.eventbus.EventBus
-
Adds the event bus subscriber to the list of listeners receiving events from the event bus.
- removeAllEventListeners(String) - Method in class org.omegazero.common.event.EventEmitter
-
Removes all event listeners from the event with the given
name, including the default listener. - removeAttachment(String) - Method in interface org.omegazero.common.util.AttachmentContainer
-
Removes an attachment identified by the given key and returns it.
- removeAttachment(String) - Method in class org.omegazero.common.util.SimpleAttachmentContainer
- removeDefaultEventListener(String) - Method in class org.omegazero.common.event.EventEmitter
-
Removes the default event listener of the given event
name. - removeEventListener(String, GenericRunnable) - Method in class org.omegazero.common.event.EventEmitter
-
Removes the given event listener from the event with the given
name. - removeLoggerOutput(LoggerOutput) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Removes the given
LoggerOutputfrom the list of configured outputs. - reopen() - Method in class org.omegazero.common.logging.FileLoggerOutput
-
Closes and re-opens the file output stream where data is written to.
- replaceFor(DelegatingTaskQueueExecutor, AbstractTaskQueueExecutor) - Method in class org.omegazero.common.event.DeferringTaskQueueExecutor
-
Transfers all deferred tasks of this
DeferringTaskQueueExecutorto a new delegate, then replaces the delegate of aDelegatingTaskQueueExecutor, where the previous delegate was this object, with this new delegate. - requireAttachment(String) - Method in interface org.omegazero.common.util.AttachmentContainer
-
Retrieves an attachment identified by the given key previously set by
AttachmentContainer.setAttachment(String, Object). - required() - Element in annotation interface org.omegazero.common.config.ConfigurationOption
-
Whether this configuration option is required.
- reserveEventIdSpace(int) - Method in class org.omegazero.common.event.EventEmitter
-
Pre-allocates internal data structures for storing event IDs up to highestId.
- reset() - Method in class org.omegazero.common.eventbus.Event
-
Resets this event instance to initial values for reuse.
- resolveLogLevel(String) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Searches the log level referenced by the given String, either by log level number or log level name.
- RotatingFileLoggerOutput - Class in org.omegazero.common.logging
-
A
FileLoggerOutputwith support for log rotation. - RotatingFileLoggerOutput(String, long) - Constructor for class org.omegazero.common.logging.RotatingFileLoggerOutput
-
Creates a new
RotatingFileLoggerOutput, writing to the givenlogFile. - RotatingFileLoggerOutput(String, long, int, int) - Constructor for class org.omegazero.common.logging.RotatingFileLoggerOutput
-
Creates a new
RotatingFileLoggerOutput, writing to the givenlogFile. - run() - Method in class org.omegazero.common.event.EventQueueExecutor.WorkerThread
-
Deprecated.
- run() - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A0
-
Runs this
GenericRunnable. - run() - Method in class org.omegazero.common.event.task.AbstractTask
-
Runs this
AbstractTask. - run() - Method in interface org.omegazero.common.event.task.Task
-
Runs this
Task. - run() - Method in interface org.omegazero.common.util.function.SpecificThrowingRunnable
-
Runs this
ThrowingRunnable. - run(A) - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A1
-
Runs this
GenericRunnablewith the given argument. - run(A, B) - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A2
-
Runs this
A2with the given arguments. - run(A, B, C) - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A3
-
Runs this
A3with the given arguments. - run(A, B, C, D) - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A4
-
Runs this
A4with the given arguments. - run(Object...) - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A0
- run(Object...) - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A1
- run(Object...) - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A2
- run(Object...) - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A3
- run(Object...) - Method in interface org.omegazero.common.event.runnable.GenericRunnable.A4
- run(Object...) - Method in interface org.omegazero.common.event.runnable.GenericRunnable
-
Runs this
GenericRunnable. - runEvent(int, Object...) - Method in class org.omegazero.common.event.EventEmitter
-
Dispatches an event with the given fastAccess event ID.
- runEvent(String, Object...) - Method in class org.omegazero.common.event.EventEmitter
-
Dispatches an event with the given
name. - runEvent(Event, Object...) - Method in class org.omegazero.common.eventbus.Subscriber
-
Gets the event handler method for the passed event and invokes it with the given arguments.
- runEventMethod(Method, Object...) - Method in class org.omegazero.common.eventbus.Subscriber
-
Validates and invokes the method eventListener with the given arguments.
- RunnableTask - Class in org.omegazero.common.event.task
- RunnableTask(Runnable) - Constructor for class org.omegazero.common.event.task.RunnableTask
-
Creates a new
RunnableTask. - RunnableTask(Runnable, int) - Constructor for class org.omegazero.common.event.task.RunnableTask
-
Creates a new
RunnableTask.
S
- SAVE_INTERVAL - Static variable in class org.omegazero.common.logging.FileLoggerOutput
-
System property
org.omegazero.common.logging.saveInterval - SerializationUtil - Class in org.omegazero.common.util
-
Utility functions for object serialization.
- serialize(Object) - Static method in class org.omegazero.common.util.SerializationUtil
-
Serializes the given object into a byte array using an
ObjectOutputStream. - setAttachment(String, Object) - Method in interface org.omegazero.common.util.AttachmentContainer
-
Stores an object identified by the given key.
- setAttachment(String, Object) - Method in class org.omegazero.common.util.SimpleAttachmentContainer
- setCanceled(boolean) - Method in class org.omegazero.common.eventbus.Event
-
Sets whether this event is canceled.
- setCoalesceListenerErrors(boolean) - Method in class org.omegazero.common.event.EventEmitter
-
If set to
true, all listeners for an event will always be executed regardless of errors thrown at the listener-level. - setDefault(String, String) - Static method in class org.omegazero.common.util.PropertyUtil
-
Sets the system property with the given key to the given value, if no property with the given key is already set.
- setDefaultEventListener(String, GenericRunnable) - Method in class org.omegazero.common.event.EventEmitter
-
Registers the default event listener for the given event
name. - setDelegate(AbstractTaskQueueExecutor) - Method in class org.omegazero.common.event.DelegatingTaskQueueExecutor
-
Sets a new
AbstractTaskQueueExecutorto delegate tasks to. - setErrorHandler(Consumer<Throwable>) - Method in class org.omegazero.common.event.AbstractTaskQueueExecutor
-
Sets the error handler that will be called when an error occurs while executing a task in any of the worker threads.
- setErrorHandler(Consumer<Throwable>) - Method in class org.omegazero.common.event.DeferringTaskQueueExecutor
- setErrorHandler(Consumer<Throwable>) - Method in class org.omegazero.common.event.DelegatingTaskQueueExecutor
- setErrorHandler(Consumer<Throwable>) - Method in class org.omegazero.common.event.EventQueueExecutor
-
Deprecated.Sets the error handler that will be called when an error occurs while executing a task in any of the worker threads.
If this handler is not set, the worker thread will exit, otherwise, the handler may choose to ignore the error and continue. - setErrorHandler(Consumer<Throwable>) - Method in class org.omegazero.common.event.SynchronousTaskQueueExecutor
- setErrorHandler(Consumer<Throwable>) - Method in class org.omegazero.common.event.TaskQueueExecutor
- setErrorHandler(Consumer<Throwable>) - Static method in class org.omegazero.common.event.Tasks
- setErrorHandler(Consumer<Throwable>) - Method in class org.omegazero.common.event.TaskScheduler
-
Sets the error handler that will be called when an error occurs while queuing a task.
- setForcedEvents(String[]) - Method in class org.omegazero.common.eventbus.Subscriber
-
Sets the array of event method names the subscriber declares itself as listening to.
- setLogLevel(LogLevel) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Sets the log level to the given value and returns the previous value.
- setSyncFlush(boolean) - Method in class org.omegazero.common.logging.FileLoggerOutput
-
Sets whether the log buffer should be flushed for every message.
- setSyncFlush(boolean) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Deprecated.Since 2.10, use
insteadgetLoggerOutputByType(FileLoggerOutput.class).setSyncFlush(syncFlush) - setUnsupportedField(Field, Object) - Method in class org.omegazero.common.config.JSONConfiguration
-
Method that is called when a field with an unsupported type is encountered.
- setUseStderr(boolean) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Deprecated.Since 2.10, use
insteadgetLoggerOutputByType(StdStreamsLoggerOutput.class).setUseStderr(u) - setUseStderr(boolean) - Method in class org.omegazero.common.logging.StdStreamsLoggerOutput
-
Set the output stream where all log messages written to this
LoggerOutputwill be printed to. - shutdown() - Static method in class org.omegazero.common.runtime.ApplicationWrapper
-
Shuts down the application and runtime.
- SimpleAttachmentContainer - Class in org.omegazero.common.util
-
An
AttachmentContainerimplementation using aHashMap, which may be used as a superclass for more specific objects. - SimpleAttachmentContainer() - Constructor for class org.omegazero.common.util.SimpleAttachmentContainer
- size() - Method in class org.omegazero.common.config.ConfigArray
-
Returns the number of elements in this
ConfigArray. - size() - Method in class org.omegazero.common.config.ConfigObject
-
Returns the number of key-value pairs in this
ConfigObject. - SpecificThrowingConsumer<E,
T> - Interface in org.omegazero.common.util.function -
Similar to a
Consumer, except that the functionalacceptmethod is allowed to throw the specified exception. - SpecificThrowingFunction<E,
T, - Interface in org.omegazero.common.util.functionR> -
Similar to a
Function, except that the functionalapplymethod is allowed to throw the specified exception. - SpecificThrowingRunnable<E> - Interface in org.omegazero.common.util.function
-
Similar to a
Runnable, except that the functionalrunmethod is allowed to throw the specified exception. - SpecificThrowingSupplier<E,
R> - Interface in org.omegazero.common.util.function -
Similar to a
Supplier, except that the functionalgetmethod is allowed to throw the specified exception. - splitQuotedString(String, char, int) - Static method in class org.omegazero.common.util.Util
-
Splits a string, possibly containing quoted substrings, on the given delimiter character.
- StandardLogger - Class in org.omegazero.common.logging
-
The standard
Loggerimplementation returned byLogger.create(). - start(String[]) - Static method in class org.omegazero.common.runtime.ApplicationWrapper
-
Starts the application.
- start(Args) - Method in interface org.omegazero.common.runtime.Application
-
Starts the application.
- StdStreamsLoggerOutput - Class in org.omegazero.common.logging
-
A
LoggerOutputwriting to stdout or stderr. - StdStreamsLoggerOutput() - Constructor for class org.omegazero.common.logging.StdStreamsLoggerOutput
- SubscribeEvent - Annotation Interface in org.omegazero.common.eventbus
-
Annotation required on methods to be identified as a valid
EventBussubscriber event handler method. - SubscribeEvent.Priority - Enum Class in org.omegazero.common.eventbus
-
Contains priority values for
SubscribeEvent.priority(). - Subscriber - Class in org.omegazero.common.eventbus
-
Represents an
EventBussubscriber. - Subscriber(Class<?>) - Constructor for class org.omegazero.common.eventbus.Subscriber
-
Creates an
Subscriberinstance for use with theEventBus. - Subscriber(Class<?>, Object) - Constructor for class org.omegazero.common.eventbus.Subscriber
-
Creates an
Subscriberinstance for use with theEventBus. - Subscriber(Object) - Constructor for class org.omegazero.common.eventbus.Subscriber
-
Alias for
Subscriber(Class, Object). - SYNC_FLUSH_DEFAULT - Static variable in class org.omegazero.common.logging.FileLoggerOutput
-
System property
org.omegazero.common.logging.syncFlush - SynchronousTaskQueueExecutor - Class in org.omegazero.common.event
-
An
AbstractTaskQueueExecutorrunning all tasks passed toqueuemethods synchronously (in the same thread). - SynchronousTaskQueueExecutor() - Constructor for class org.omegazero.common.event.SynchronousTaskQueueExecutor
-
Creates a new
SynchronousTaskQueueExecutor. - sysErr - Static variable in class org.omegazero.common.logging.LoggerUtil
-
The initial value of
System.err. - sysOut - Static variable in class org.omegazero.common.logging.LoggerUtil
-
The initial value of
System.out.
T
- Task - Interface in org.omegazero.common.event.task
-
Represents a
Runnablewith a priority. - TaskQueueExecutor - Class in org.omegazero.common.event
- TaskQueueExecutor(Queue<Task>, int, boolean, String) - Constructor for class org.omegazero.common.event.TaskQueueExecutor
-
Creates a new
TaskQueueExecutor. - TaskQueueExecutor.Builder - Class in org.omegazero.common.event
-
Builder used to create a
TaskQueueExecutor. - TaskQueueExecutor.Handle - Class in org.omegazero.common.event
-
An opaque class used for task execution control.
- Tasks - Class in org.omegazero.common.event
-
Convenience class for globally scheduled tasks using a
TaskScheduler. - TASKS - Static variable in class org.omegazero.common.event.Tasks
-
The
TaskSchedulerinstance, an alias ofTasks.I. - TaskScheduler - Class in org.omegazero.common.event
-
Provides functions for time-based scheduling, running functions either once or periodically, similar to JavaScript's
setTimeoutandsetInterval. - TaskScheduler() - Constructor for class org.omegazero.common.event.TaskScheduler
-
Creates a TaskScheduler and starts the background execution thread.
- TaskScheduler(AbstractTaskQueueExecutor) - Constructor for class org.omegazero.common.event.TaskScheduler
-
Creates a TaskScheduler with the given
AbstractTaskQueueExecutorto run tasks, and starts the background execution thread. - TaskScheduler.TimerTask - Class in org.omegazero.common.event
-
Represents a task managed by a
TaskScheduler. - ThrowingConsumer<T> - Interface in org.omegazero.common.util.function
-
Similar to a
Consumer, except that the functionalacceptmethod is allowed to throw any exception. - ThrowingFunction<T,
R> - Interface in org.omegazero.common.util.function -
Similar to a
Function, except that the functionalapplymethod is allowed to throw any exception. - ThrowingRunnable - Interface in org.omegazero.common.util.function
-
Similar to a
Runnable, except that the functionalrunmethod is allowed to throw any exception. - ThrowingSupplier<R> - Interface in org.omegazero.common.util.function
-
Similar to a
Supplier, except that the functionalgetmethod is allowed to throw any exception. - timeout(Runnable, long) - Static method in class org.omegazero.common.event.Tasks
-
Deprecated.Since 2.9.1, use
Tasks.I - timeout(Runnable, long) - Method in class org.omegazero.common.event.TaskScheduler
-
Schedules a task to be run at the specified timeout relative to the time this function was called.
- timeout(Consumer<Object[]>, long, Object...) - Static method in class org.omegazero.common.event.Tasks
-
Deprecated.Since 2.9.1, use
Tasks.I - timeout(Consumer<Object[]>, long, Object...) - Method in class org.omegazero.common.event.TaskScheduler
-
Schedules a task to be run at the specified timeout relative to the time this function was called.
- toArray() - Method in class org.omegazero.common.config.ConfigArray
-
Converts this
ConfigArrayto anObjectarray. - toArray(Class<T>) - Method in class org.omegazero.common.config.ConfigArray
-
Converts this
ConfigArrayto an array of the given type. - toHexString(byte[]) - Static method in class org.omegazero.common.util.ArrayUtil
-
Represents the given data as a string of hexadecimal characters.
- toHexString(byte[], int, int) - Static method in class org.omegazero.common.util.ArrayUtil
-
Represents the given data, starting at offset and with the given length, as a string of hexadecimal characters.
- toString() - Method in class org.omegazero.common.config.ConfigArray
-
Returns a string representation of this
ConfigArray. - toString() - Method in class org.omegazero.common.config.ConfigObject
-
Returns a string representation of this
ConfigObject. - toString() - Method in class org.omegazero.common.eventbus.EventResult
- toString() - Method in enum class org.omegazero.common.logging.LogLevel
- trace(Object...) - Method in interface org.omegazero.common.logging.Logger
-
Logs the given message at
LogLevel.TRACE. - TRACE - Enum constant in enum class org.omegazero.common.logging.LogLevel
-
The highest log level.
- transferTasks(AbstractTaskQueueExecutor) - Method in class org.omegazero.common.event.DeferringTaskQueueExecutor
-
Transfers all deferred tasks of this
DeferringTaskQueueExecutorto the givenAbstractTaskQueueExecutor.
U
- undaemon() - Method in class org.omegazero.common.event.TaskScheduler.TimerTask
-
Marks this task as a non-daemon task.
- unmuteLogger(String) - Static method in class org.omegazero.common.logging.LoggerUtil
-
Unmutes the
StandardLoggerwith the given name, reversing any mute operation by a previous call toLoggerUtil.muteLogger(String). - unqueue(Task) - Method in class org.omegazero.common.event.AbstractTaskQueueExecutor
-
Removes the given task from the queue.
- unqueue(Task) - Method in class org.omegazero.common.event.DeferringTaskQueueExecutor
- unqueue(Task) - Method in class org.omegazero.common.event.DelegatingTaskQueueExecutor
- unqueue(Task) - Method in class org.omegazero.common.event.SynchronousTaskQueueExecutor
-
Removes the given task from the queue.
- unqueue(Task) - Method in class org.omegazero.common.event.TaskQueueExecutor
- unregister(Class<?>) - Method in class org.omegazero.common.eventbus.EventBus
-
Removes all event bus subscribers of the given type from the list of listeners receiving events from the event bus.
- unregister(Object) - Method in class org.omegazero.common.eventbus.EventBus
-
Removes the event bus subscriber with instance from the list of listeners receiving events from the event bus.
- unregister(Subscriber) - Method in class org.omegazero.common.eventbus.EventBus
-
Removes the given event bus subscriber from the list of listeners receiving events from the event bus.
- Util - Class in org.omegazero.common.util
-
Class containing several mostly unrelated utility methods.
V
- value() - Method in enum class org.omegazero.common.eventbus.SubscribeEvent.Priority
-
The
intvalue of thisPriorityvalue. - valueOf(String) - Static method in enum class org.omegazero.common.eventbus.SubscribeEvent.Priority
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.omegazero.common.logging.LogLevel
-
Returns the enum constant of this class with the specified name.
- values() - Method in class org.omegazero.common.config.ConfigObject
-
Returns an unmodifiable collection of all values of this
ConfigObject. - values() - Static method in enum class org.omegazero.common.eventbus.SubscribeEvent.Priority
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.omegazero.common.logging.LogLevel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VERSION - Static variable in class org.omegazero.common.OmzLib
-
The version string of omz-java-lib.
W
- waitForNonDaemonThreads() - Static method in class org.omegazero.common.util.Util
-
Blocks this thread until all non-daemon threads apart from the caller and "DestroyJavaVM" thread have exited (
Util.nonDaemonThreadRunning()returns false). - waitForNonDaemonThreads(int) - Static method in class org.omegazero.common.util.Util
-
Blocks this thread until all non-daemon threads apart from the caller and "DestroyJavaVM" thread have exited (
Util.nonDaemonThreadRunning()returns false), or at least timeout milliseconds have passed. - waitForTask() - Method in class org.omegazero.common.event.EventQueue
-
Deprecated.Blocks the thread until a task to execute becomes available.
- warn(Object...) - Method in interface org.omegazero.common.logging.Logger
-
Logs the given message at
LogLevel.WARN. - WARN - Enum constant in enum class org.omegazero.common.logging.LogLevel
-
Information messages that may need additional attention.
- WorkerThread() - Constructor for class org.omegazero.common.event.EventQueueExecutor.WorkerThread
-
Deprecated.
- workerThreads(int) - Method in class org.omegazero.common.event.TaskQueueExecutor.Builder
-
Sets the maximum number of worker threads allowed for the
TaskQueueExecutor. - write(int) - Method in class org.omegazero.common.logging.LoggerOutputStream
- writeLine(String, String) - Method in class org.omegazero.common.logging.FileLoggerOutput
- writeLine(String, String) - Method in interface org.omegazero.common.logging.LoggerOutput
-
Writes the given log line to this
LoggerOutput. - writeLine(String, String) - Method in class org.omegazero.common.logging.RotatingFileLoggerOutput
- writeLine(String, String) - Method in class org.omegazero.common.logging.StdStreamsLoggerOutput
- writeOut() - Method in class org.omegazero.common.logging.LoggerOutputStream
-
Writes the data stored in the internal buffer as a log message to the
Loggerand with theLogLevelgiven in the constructor. - writer - Variable in class org.omegazero.common.logging.FileLoggerOutput
-
The output writer.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
ArrayUtil.indexOf(byte[], byte[])instead