Module org.refcodes.properties

Package org.refcodes.properties

package org.refcodes.properties

This artifact provides a canonical model for processing properties from various different formats (*.yaml, *.ini, *.toml, *.json, *.xml or *.properties) and locations (JAR files, file system files, streams, HTTP resources or GIT repositories) and for converting properties to and from POJOs (plain java objects) and for applying various transformations and views to the properties.

Please refer to the refcodes-properties: Managing your application's configuration documentation for an up-to-date and detailed description on the usage of this artifact.

Class	Description
AbstractPropertiesBuilderDecorator<T extends Properties.PropertiesBuilder>
AbstractPropertiesDecorator<T extends Properties>	Decorates the provided Properties and delegates method calls to them Properties.
AbstractResourceProperties	Base class for various ResourceProperties implementations using a ResourceProperties.ResourcePropertiesBuilder instance under the hood.
AbstractResourcePropertiesBuilder	Implementation of the mutable ResourceProperties.ResourcePropertiesBuilder interface.
AbstractResourcePropertiesBuilderDecorator<T extends ResourceProperties.ResourcePropertiesBuilder>
AbstractResourcePropertiesDecorator<T extends ResourceProperties>	Decorates the provided ResourceProperties and delegates method calls to them ResourceProperties.
ArgsProperties	The ArgsProperties takes them command line arguments "as is" and converts them into key/value pairs as of the Properties semantics.
ConfigurationRuntimeException	Base exception for the configuration artifact.
EnvironmentProperties	Extension of the Properties type overwriting methods in order to access the operating system's environment variables as of env on Linux or Unix shells or set on Windows machines (e.g."
JavaProperties	Implementation of the ResourceProperties interface with support of so called "Java properties" (or just "properties").
JavaProperties.JavaPropertiesFactory	The JavaProperties.JavaPropertiesFactory represents a ResourcePropertiesFactory creating instances of type JavaProperties.
JavaPropertiesBuilder	Implementation of the ResourceProperties.ResourcePropertiesBuilder interface with support of so called "Java properties" (or just "properties").
JavaPropertiesBuilder.JavaPropertiesBuilderFactory	The JavaPropertiesBuilder.JavaPropertiesBuilderFactory represents a ResourcePropertiesFactory.ResourcePropertiesBuilderFactory creating instances of type JavaPropertiesBuilder.
JsonProperties	Implementation of the ResourceProperties interface with support of so called "JSON properties".
JsonProperties.JsonPropertiesFactory	The JsonProperties.JsonPropertiesFactory represents a ResourcePropertiesFactory creating instances of type JsonProperties.
JsonPropertiesBuilder	Implementation of the ResourceProperties.ResourcePropertiesBuilder interface with support of so called "JSON properties" (or just "properties").
JsonPropertiesBuilder.JsonPropertiesBuilderFactory	The JsonPropertiesBuilder.JsonPropertiesBuilderFactory represents a ResourcePropertiesFactory.ResourcePropertiesBuilderFactory creating instances of type JsonPropertiesBuilder.
NormalizedPropertiesDecorator	The NormalizedPropertiesDecorator type decorates a Properties instance and converts a path delimiter such as the full-stop (".") to the Properties properties' path delimiter slash ("/", as of AbstractPropertiesDecorator.getDelimiter()).
PolyglotProperties	Implementation of the ResourceProperties interface with support of so called "PolyglotProperties" (or just "properties").
PolyglotProperties.PolyglotPropertiesFactory	The PolyglotProperties.PolyglotPropertiesFactory is a meta factory using a collection of ResourcePropertiesFactory instances to deliver ResourceProperties instances.
PolyglotPropertiesBuilder	Implementation of the ResourceProperties.ResourcePropertiesBuilder interface with support of so called "PolyglotPropertiesBuilder" (or just "properties").
PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory	The PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory is a meta factory using a collection of ResourcePropertiesFactory.ResourcePropertiesBuilderFactory instances to deliver ResourceProperties.ResourcePropertiesBuilder instances.
ProfileProperties	The ProfileProperties extend the Properties with Runtime-Profiles support.
ProfileProperties.MutableProfileProperties	The Interface MutableProfileProperties.
ProfileProperties.ProfilePropertiesBuilder	The Interface ProfilePropertiesBuilder.
ProfilePropertiesDecorator	The ProfilePropertiesDecorator type decorates a Properties instance and enriches it with profile support as of ProfileProperties.
ProfilePropertiesProjection	The ProfilePropertiesProjection applies the profiles as of ProfileProperties.getRuntimeProfiles() onto the encapsulated Properties (ProfileProperties) and provides a view of them Properties (ProfileProperties) from the profiles' point of view e.g. as when profiles have been applied to them Properties (ProfileProperties).
Properties	The Properties are a https://www.metacodes.proization of the Dictionary.
Properties.MutableProperties	The interface Properties.MutableProperties defines "dirty" methods allowing to modify ("mutate") the properties.
Properties.PropertiesBuilder	The interface Properties.PropertiesBuilder defines builder functionality on top of the properties .
PropertiesAccessor	Provides an accessor for a Properties property.
PropertiesAccessor.PropertiesBuilder<B extends PropertiesAccessor.PropertiesBuilder<B>>	Provides a builder method for a Properties property returning the builder for applying multiple build operations.
PropertiesAccessor.PropertiesMutator	Provides a mutator for a Properties property.
PropertiesAccessor.PropertiesProperty	Provides a Properties property.
PropertiesBuilderImpl	The Class PropertiesBuilderImpl.
PropertiesImpl	The Class PropertiesImpl.
PropertiesNotation	The currently known notations for ResourceProperties implementations.
PropertiesNotationAccessor	Provides an accessor for a PropertiesNotation property.
PropertiesNotationAccessor.PropertiesNotationBuilder<B extends PropertiesNotationAccessor.PropertiesNotationBuilder<B>>	Provides a builder method for a PropertiesNotation property returning the builder for applying multiple build operations.
PropertiesNotationAccessor.PropertiesNotationMutator	Provides a mutator for a PropertiesNotation property.
PropertiesNotationAccessor.PropertiesNotationProperty	Provides a PropertiesNotation property.
PropertiesPath	Enumeration representing defined path values.
PropertiesPrecedence	Defines a meta-interface in order to retrieve properties from various different properties sources (Properties instances) by querying all the herein contained Properties instances in the order of them being added.
PropertiesPrecedence.MutablePropertiesPrecedence	The interface PropertiesPrecedence.MutablePropertiesPrecedence defines "dirty" methods allowing to modify ("mutate") the PropertiesPrecedence: Add or remove Properties inside a PropertiesPrecedence instance.
PropertiesPrecedence.PropertiesPrecedenceBuilder	The interface PropertiesPrecedence.MutablePropertiesPrecedence defines builder functionality on top of the properties .
PropertiesPrecedenceBuilderComposite
PropertiesPrecedenceComposite	Retrieve properties from various different properties sources (Properties instances) by querying all the herein contained Properties instances in the order of them being added.
PropertiesSugar	Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the construction of Properties precedences using ProfilePropertiesDecorator, ProfilePropertiesProjection, ResourceProperties or PropertiesPrecedenceComposite (and the like).
ReloadMode	Mode of operation regarding the ResourceProperties.reload(ReloadMode) method.
ResourceLoaderBuilder<B extends ResourceLoaderBuilder<B>>	This interface provides builder additions (as of the builder pattern for chained configuring method calls) for "dynamic" ResourceProperties: As ResourceProperties are immutable from an interface's point of view, there are no mutating methods provided.
ResourceProperties	The ResourceProperties are a https://www.metacodes.proization of the Dictionary.
ResourceProperties.MutableResoureProperties	The interface ResourceProperties.MutableResoureProperties defines "dirty" methods allowing to modify ("mutate") the ResourceProperties.
ResourceProperties.ResourcePropertiesBuilder	The interface ResourceProperties.ResourcePropertiesBuilder defines builder functionality on top of the ResourceProperties.MutableResoureProperties.
ResourcePropertiesFactory	Factory interface for creating ResourceProperties instances.
ResourcePropertiesFactory.ResourcePropertiesBuilderFactory	Factory interface for creating ResourceProperties.ResourcePropertiesBuilder instances.
ScheduledResourceProperties	The ScheduledResourceProperties enrich ResourceProperties with scheduling functionality whereby the properties are being automatically reloaded periodically via ResourceProperties.reload(ReloadMode).
ScheduledResourceProperties.ScheduledMuableResourceProperties	The interface ScheduledResourceProperties.ScheduledMuableResourceProperties defines "dirty" methods allowing to modify ("mutate") the ScheduledResourceProperties.
ScheduledResourceProperties.ScheduledResourcePropertiesBuilder	The interface ScheduledResourceProperties.ScheduledResourcePropertiesBuilder defines builder functionality on top of the ScheduledResourceProperties.ScheduledMuableResourceProperties.
ScheduledResourcePropertiesBuilderDecorator	The ScheduledResourcePropertiesBuilderDecorator decorates ResourceProperties.ResourcePropertiesBuilder from which the properties are to be reloaded periodically via AbstractResourcePropertiesBuilderDecorator.reload(ReloadMode).
ScheduledResourcePropertiesDecorator	The ScheduledResourcePropertiesDecorator decorates ResourceProperties from which the properties are to be reloaded periodically via AbstractResourcePropertiesDecorator.reload(ReloadMode).
StrictProperties	The StrictProperties extends the Properties with all the getters to throw a KeyNotFoundRuntimeException instead of returning null in case the key was not found.
StrictProperties.MutableStrictProperties	The Interface MutableStrictProperties.
StrictProperties.StrictPropertiesBuilder	The Interface StrictPropertiesBuilder.
StrictPropertiesDecorator	The StrictPropertiesDecorator type decorates a Properties instance with all the getters to throw a KeyNotFoundRuntimeException instead of returning null in case the key was not found.
SystemProperties	Extension of the Properties type overwriting methods in order to access system properties as passed via the "-Dkey=value" when launching the JVM (e.g.java -Dconsole.width=220) The keys are transformed to a system properties by removing a prefixed "/" path delimiter (as of Properties.getDelimiter() and converting all other path delimiters "/" to the system property's (de facto standard) separator ".".
TomlProperties	Implementation of the ResourceProperties interface with support of so called "TOML properties".
TomlProperties.TomlPropertiesFactory	The TomlProperties.TomlPropertiesFactory represents a ResourcePropertiesFactory creating instances of type TomlProperties.
TomlPropertiesBuilder	Implementation of the ResourceProperties.ResourcePropertiesBuilder interface with support of so called "TOML properties".
TomlPropertiesBuilder.TomlPropertiesBuilderFactory	The TomlPropertiesBuilder.TomlPropertiesBuilderFactory represents a ResourcePropertiesFactory.ResourcePropertiesBuilderFactory creating instances of type TomlPropertiesBuilder.
XmlProperties	Implementation of the ResourceProperties interface with support of so called "XML properties".
XmlProperties.XmlPropertiesFactory	The XmlProperties.XmlPropertiesFactory represents a ResourcePropertiesFactory creating instances of type XmlProperties.
XmlPropertiesBuilder	Implementation of the ResourceProperties.ResourcePropertiesBuilder interface with support of so called "XML properties" (or just "properties").
XmlPropertiesBuilder.XmlPropertiesBuilderFactory	The XmlPropertiesBuilder.XmlPropertiesBuilderFactory represents a ResourcePropertiesFactory.ResourcePropertiesBuilderFactory creating instances of type XmlPropertiesBuilder.
YamlProperties	Implementation of the ResourceProperties interface with support of so called "YAML properties".
YamlProperties.YamlPropertiesFactory	The YamlProperties.YamlPropertiesFactory represents a ResourcePropertiesFactory creating instances of type YamlProperties.
YamlPropertiesBuilder	Implementation of the ResourceProperties.ResourcePropertiesBuilder interface with support of so called "YAML properties" (or just "properties").
YamlPropertiesBuilder.YamlPropertiesBuilderFactory	The YamlPropertiesBuilder.YamlPropertiesBuilderFactory represents a ResourcePropertiesFactory.ResourcePropertiesBuilderFactory creating instances of type YamlPropertiesBuilder.