Package org.refcodes.runtime

package org.refcodes.runtime

Provides runtime-oriented abstractions, utilities and diagnostics for the REFCODES.ORG toolkit.

This package bundles functionality related to the execution environment, system interaction and runtime introspection. It includes utilities for accessing platform characteristics such as the OperatingSystem, Shell and Host, as well as facilities for working with system properties and environment variables via SystemProperty and EnvironmentVariable.

In addition, this package provides a lightweight diagnostics model based on the Diagnosable interface. Implementations can expose their internal state as structured Schema representations to support debugging, inspection and documentation.

The Options type extends Settings by resolving values from multiple runtime sources (such as provided values, system properties and environment variables) while preserving information about their origin. Diagnostic behavior can be configured via DiagnosticOptions.

The Settings is colocated in this package as a reusable, dynamic configuration container that underpins runtime features such as options resolution and diagnostics, as it is particularly well suited for scenarios where properties are not known at compile time but emerge dynamically at runtime.

Overall, this package forms the foundation for interacting with and introspecting the runtime environment in a structured and extensible manner.

Class	Description
Arguments	This utility class provides method useful for working with command line arguments (as of public static void main(String[] args) ).
ConfigLocator	This enumeration represents configuration folder locations (of type File) and configuration file retrieval as of the chosen configuration mode.
Correlation	The Correlation assigns an according (as of the enumeration) Correlation-TID to the invoking process, this TID is used in log files and is part of the process's request or response pay-load in order to track process execution throughout a JVM.
Diagnosable	The Diagnosable mixin provides means for a data structure to describe itself as a diagnostic report generating a Schema hierarchy configured by (optional) Options.
DiagnosticOption	The DiagnosticOption enumeration defines known options supported by the DiagnosticOptions class.
DiagnosticOptions	The DiagnosticOptions represent a set of options influencing how a Diagnosable instance renders its runtime diagnostics Schema.
DiagnosticOptions.Builder	Builder for creating DiagnosticOptions instances.
EnvironmentVariable	EnvironmentVariable for retrieving some common environment variables with ease.
Execution	Utility for acquiring runtime information on software systems, classes or objects.
Execution.NonExistingValueClass	This class indicates a non existing value in the name-to-value mapping.
Host	The Host type abstracts the computer system on which this application runs on.
NativeImageCode	Defines the values of the SystemProperty.NATIVE_IMAGE_CODE system property.
NativeImageKind	Defines the values of the SystemProperty.NATIVE_IMAGE_KIND system property.
OperatingSystem	Enumeration with the (supported) operating systems.
Option	The Option type extends the Setting type and describes enumerations representing well known and normalized (hierarchical) configuration options for subclasses of the Options container.
Options	The Options class serves as a generic information container for providing arbitrary, optional parameters and interfaces with the runtime environment: The Options container provides flexible, extensible configuration lookup with support for explicit values, JVM system properties, and environment variables.
Options.Builder	Builder for creating Options instances.
OptionsSchemaOntology	The OptionsSchemaOntology describes the terms used for Schema generation of the Options type.
OptionsSchemaOntology.ValueSource
Setting	The Setting type describes enumerations representing well known and normalized (hierarchical) settings for subclasses of the Settings container.
Settings	The Settings type serves as a flexible, namespace-aware container for providing arbitrary metadata and dynamic configuration properties.
Settings.Builder	Builder for creating Settings instances.
Settings.Node
Settings.Properties
Settings.Root
Shell	Enumeration with the (relevant) shells (command line interpreters).
SystemContext	Describes the context within a system's environment regarding host, user and application contexts as well as the currently invoked Java runtime session.
SystemProperty	SystemProperty define values to be used at runtime.
Terminal	Enumeration with the (relevant) terminals as well as interpolated terminal metrics.
Terminal.CharSetCapability	The Terminal.CharSetCapability defines three categories of character capabilities as observed on various platform.