Package org.microbean.settings

Provides classes and interfaces that help with acquiring settings from CDI-based programs.

See: Description

Interface Summary

Interface	Description
Converter<T>	A Function that can convert a Value into some other kind of object.
ConverterProvider	A provider of appropriately-typed Converter instances, given Class, Type or TypeLiteral instances.

Class Summary

Class	Description
Arbiter	Provides value arbitration services most commonly to a Settings instance in cases where setting values would otherwise be indistinguishable from one another.
Configured.Literal	An AnnotationLiteral that implements the Configured interface/annotation.
Converters	A hub for the centralized conversion of Values.
EnvironmentVariablesSource	A Source that retrieves values from environment variables.
Setting.Literal	An AnnotationLiteral that implements the Setting interface/annotation.
Settings	A provider of named setting values sourced from any number of sources.
SettingsExtension	An Extension providing support for the Setting and Configured annotations, as well as injection of Settings instances.
Source	An abstraction of a source of String-typed configuration values.
SourceOrderArbiter	A simple Arbiter implementation that performs arbitration among Values by selecting the Value whose affiliated Source appears first in the Set of Sources supplied to the SourceOrderArbiter.arbitrate(Set, String, Set, Collection) method.
SystemPropertiesSource	A Source that retrieves values from system properties.
Value	A Supplier of Strings and hence an abstraction of a (definitionally) String-typed setting value, additionally encompassing the setting name for which it is applicable and the Source whence it originated.

Exception Summary

Exception	Description
AmbiguousValuesException	A SettingsException indicating that some Value instances were found to be ambiguous.
ArbitrationException	A SettingsException indicating a procedural problem with value arbitration.
ConversionException	A SettingsException indicating a procedural problem with conversion.
MalformedValuesException	A SettingsException indicating that at least one Value from a Source was malformed.
SettingsException	A RuntimeException indicating a problem with an operation from, most likely, a Settings instance.
ValueAcquisitionException	A SettingsException indicating a procedural problem with acquiring Values from, most likely, Sources.

Annotation Types Summary

Annotation Type	Description
Configured	A Qualifier indicating that a relevant instance should be configured immediately after being instantiated.
Setting	A CDI Qualifier indicating that the annotated element should be provided via a Settings-originated value acquisition operation, such as Settings.get(String, Set, Converter, BiFunction).

Package org.microbean.settings Description

Provides classes and interfaces that help with acquiring settings from CDI-based programs.

Author:

Laird Nelson

See Also:

Settings