Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractDecryptor - Class in org.aeonbits.owner.crypto
-
An abstract implementation of Decryptor.
- AbstractDecryptor() - Constructor for class org.aeonbits.owner.crypto.AbstractDecryptor
-
For the subclasses, which is the only thing that can call it.
- AbstractEncryptor - Class in org.aeonbits.owner.crypto
-
An abstract implementation of Encryptor.
- AbstractEncryptor() - Constructor for class org.aeonbits.owner.crypto.AbstractEncryptor
-
For the subclasses, which is the only thing that can call it.
- accept(URI) - Method in class org.aeonbits.owner.extras.jndi.JndiLoader
- accept(URI) - Method in class org.aeonbits.owner.extras.loaders.HoconLoader
- accept(URI) - Method in class org.aeonbits.owner.extras.loaders.ZooKeeperLoader
-
Accepts a source whose scheme is
zookeeper, and no other. - accept(URI) - Method in class org.aeonbits.owner.formats.json.JsonLoader
- accept(URI) - Method in class org.aeonbits.owner.formats.toml.TomlLoader
- accept(URI) - Method in class org.aeonbits.owner.formats.yaml.YamlLoader
- accept(URI) - Method in class org.aeonbits.owner.loaders.DotEnvLoader
- accept(URI) - Method in class org.aeonbits.owner.loaders.IniLoader
- accept(URI) - Method in interface org.aeonbits.owner.loaders.Loader
-
Indicates whether this Loader accepts the URI, guessing the content type from it.
- accept(URI) - Method in class org.aeonbits.owner.loaders.PropertiesLoader
- accept(URI) - Method in class org.aeonbits.owner.loaders.SystemLoader
- accept(URI) - Method in class org.aeonbits.owner.loaders.XMLLoader
- Accessible - Interface in org.aeonbits.owner
-
Allows a
Configobject to access the contents of the properties, providing utility methods to perform consequent operations. - add(Object, T) - Static method in class org.aeonbits.owner.ConfigCache
-
Adds a
Configobject into the cache. - addPropertyChangeListener(PropertyChangeListener) - Method in interface org.aeonbits.owner.Mutable
-
Adds a
PropertyChangeListenerto the Mutable interface. - addPropertyChangeListener(String, PropertyChangeListener) - Method in interface org.aeonbits.owner.Mutable
-
Adds a PropertyChangeListener to the listener list for a specific property.
- addReloadListener(ReloadListener) - Method in interface org.aeonbits.owner.Reloadable
-
Add a ReloadListener.
- AesGcmHandler - Class in org.aeonbits.owner.handlers
-
The cipher this library ships: AES-256/GCM over a passphrase, behind the name
aes-gcm. - AesGcmHandler(char[]) - Constructor for class org.aeonbits.owner.handlers.AesGcmHandler
-
A handler under the name
aes-gcm, encrypting atAesGcmHandler.DEFAULT_ITERATIONS. - AesGcmHandler(String) - Constructor for class org.aeonbits.owner.handlers.AesGcmHandler
-
The same, from a
String, which is what a passphrase read from the environment is. - AesGcmHandler(String, char[]) - Constructor for class org.aeonbits.owner.handlers.AesGcmHandler
-
A handler under a name of your own, which is how two keys are readable at once during a rotation.
- AesGcmHandler(String, char[], int) - Constructor for class org.aeonbits.owner.handlers.AesGcmHandler
-
A handler under a name of your own, encrypting at a count of your own.
- all() - Method in class org.aeonbits.owner.loaders.SourceOptions
-
The options, in the order they were written, with repetitions kept: a loader that lets a later option refine an earlier one needs to see both, and in which order.
- anyDeclaredOn(Method) - Static method in class org.aeonbits.owner.validation.Constraints
-
Tells whether the given method carries a constraint written on the method itself, as opposed to one written on a type argument of its return type.
- anyOn(Method) - Static method in class org.aeonbits.owner.validation.Constraints
-
Tells whether the given method carries any constraint at all - on the method itself, as in
@Min(12) int port(), or on a type argument of its return type, as inOptional<@Min(12) Integer> port(). - asString(Object) - Static method in class org.aeonbits.owner.util.Util
-
Returns the string representation of the given object, or
nullif it isnull. - ASYNC - Enum constant in enum org.aeonbits.owner.Config.HotReloadType
-
The hot reload will happen in background at the specified interval.
B
- BACKSLASH - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.Continuation
-
A line ending in a backslash joins the next, the backslash and the newline being dropped.
- bareKeys() - Method in class org.aeonbits.owner.loaders.IniDialect
-
What a name with no separator means.
- bareNames() - Method in class org.aeonbits.owner.loaders.EnvDialect
-
What is done with a line that names a variable without assigning to it.
- BeanValidator - Class in org.aeonbits.owner.extras.validation
-
Checks a configuration's values with Bean Validation - the annotations everybody already writes,
@Min,@NotNull,@Patternand the rest - so that they mean something on a method named the way this library teaches. - BeanValidator() - Constructor for class org.aeonbits.owner.extras.validation.BeanValidator
-
A validator is built with no arguments, both when it is registered by hand and when
ServiceLoaderfinds it on the class path. - beforePropertyChange(PropertyChangeEvent) - Method in interface org.aeonbits.owner.event.TransactionalPropertyChangeListener
-
This method is invoked before the property is changed.
- beforeReload(ReloadEvent) - Method in interface org.aeonbits.owner.event.TransactionalReloadListener
-
This method is invoked before the properties are reloaded.
- Being expansion is the point - Search tag in interface org.aeonbits.owner.handlers.ValueHandler
- Section
- blankLookingCharacterIn(String) - Static method in class org.aeonbits.owner.util.Util
-
Describes the first character of the text that the eye reads as a blank but the parser does not: a no-break space, a narrow one, a zero-width one.
- BYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The base unit.
- ByteSize - Class in org.aeonbits.owner.util.bytesize
-
A unit of byte size, such as "512 kilobytes".
- ByteSize(double, ByteSizeUnit) - Constructor for class org.aeonbits.owner.util.bytesize.ByteSize
-
Creates a byte size value from a
doublevalue and aByteSizeUnit. - ByteSize(long) - Constructor for class org.aeonbits.owner.util.bytesize.ByteSize
-
Creates a byte size value from a
longvalue representing the number of bytes. - ByteSize(long, ByteSizeUnit) - Constructor for class org.aeonbits.owner.util.bytesize.ByteSize
-
Creates a byte size value from a
longvalue and aByteSizeUnit. - ByteSize(String, ByteSizeUnit) - Constructor for class org.aeonbits.owner.util.bytesize.ByteSize
-
Creates a byte size value from a
Stringvalue and aByteSizeUnit. - ByteSize(BigDecimal, ByteSizeUnit) - Constructor for class org.aeonbits.owner.util.bytesize.ByteSize
-
Creates a byte size value from two parts, a value and a
ByteSizeUnit. - ByteSizeConverter - Class in org.aeonbits.owner.converters
-
Reads a
ByteSizefrom a value such as10 MB. - ByteSizeConverter() - Constructor for class org.aeonbits.owner.converters.ByteSizeConverter
-
Built with no arguments: a converter named by
Config.ConverterClassis instantiated reflectively, so this constructor is part of the contract rather than an accident of there being no state. - ByteSizeStandard - Enum in org.aeonbits.owner.util.bytesize
-
Represents the possible standards that a
ByteSizeUnitcan have. - ByteSizeUnit - Enum in org.aeonbits.owner.util.bytesize
-
Specifies the available byte size units that a
ByteSizecan have.
C
- child(String, String) - Static method in class org.aeonbits.owner.loaders.PropertyKeys
-
The key of a child below its parent:
serverandhostgiveserver.host. - clear() - Static method in class org.aeonbits.owner.ConfigCache
-
Removes all of the cached instances.
- clear() - Method in interface org.aeonbits.owner.Mutable
-
Clears all properties.
- clearProperty(String) - Static method in class org.aeonbits.owner.ConfigFactory
-
Clears the value for the property having the given key.
- clearProperty(String) - Method in interface org.aeonbits.owner.Factory
-
Clears the value for the property having the given key.
- Collections - Class in org.aeonbits.owner.util
-
Utility class to create a maps, lists and sets
- compareTo(ByteSize) - Method in class org.aeonbits.owner.util.bytesize.ByteSize
-
Compares two byte sizes by the amount of data they represent, so that
1 MiBcomes after1 MBand the unit each of them is written in does not enter into it. - COMPOSE - Static variable in class org.aeonbits.owner.loaders.EnvDialect
-
The rules of
env_filein Docker Compose, which — unlikedocker run --env-file, and this is the trap — does treat quotes as delimiters. - config() - Method in class org.aeonbits.owner.validation.ConstrainedProperty
-
The configuration object the method belongs to.
- Config - Interface in org.aeonbits.owner
-
Marker interface that must be implemented by all Config sub-interfaces.
- Config.CollectionConverterClass - Annotation Type in org.aeonbits.owner
-
Specifies a
class to convert the property value into theConverterCollectionreturned by the method, in a single step. - Config.ConverterClass - Annotation Type in org.aeonbits.owner
-
Specifies a
class to allow the user to define a custom conversion logic for the type returned by the method.Converter - Config.DeclaredOnly - Annotation Type in org.aeonbits.owner
-
Shows, through
AccessibleandObject.toString(), only the properties this interface declares. - Config.DecryptorClass - Annotation Type in org.aeonbits.owner
-
The default
Decryptorfor everyConfig.EncryptedValueof this interface that does not name one of its own, so that a whole configuration can share a decryptor. - Config.DefaultValue - Annotation Type in org.aeonbits.owner
-
Default value to be used if no property is found.
- Config.Description - Annotation Type in org.aeonbits.owner
-
What this property is for, in a sentence, written where the property is declared.
- Config.DisableableFeature - Enum in org.aeonbits.owner
-
This enum contains the features that can be disabled using the annotation
Config.DisableFeature. - Config.DisableFeature - Annotation Type in org.aeonbits.owner
-
Specifies to disable some of the features supported by the API.
- Config.EncryptedValue - Annotation Type in org.aeonbits.owner
-
Declares that this method's value is encrypted, and is to be decrypted by the
Decryptornamed here or, when none is, by the one the interface declares withConfig.DecryptorClass. - Config.HotReload - Annotation Type in org.aeonbits.owner
-
Specify that the class implements hot reloading of properties from filesystem baked
Config.Sources(hot reloading can't be applied to all types of URIs). - Config.HotReloadType - Enum in org.aeonbits.owner
-
Allows to specify which type of HotReload should be applied.
- Config.Key - Annotation Type in org.aeonbits.owner
-
The key used for lookup for the property.
- Config.LoadPolicy - Annotation Type in org.aeonbits.owner
-
Specifies the policy for loading the properties files.
- Config.LoadType - Enum in org.aeonbits.owner
-
Specifies the policy type to use to load the
Config.Sourcesfiles for properties. - Config.Mandatory - Annotation Type in org.aeonbits.owner
-
Marks a property as mandatory.
- Config.Prefix - Annotation Type in org.aeonbits.owner
-
Specifies a prefix that is prepended to the keys of all the properties declared in the annotated interface.
- Config.PreprocessorClasses - Annotation Type in org.aeonbits.owner
-
Specifies a
class to allow the user to define a custom logic to pre-process the property value before being used by the library.Preprocessor - Config.Sensitive - Annotation Type in org.aeonbits.owner
-
Marks a property as sensitive, so that its value is replaced by
Config.Sensitive.MASKin the output meant to be read by a human:Accessible.list(java.io.PrintStream),Accessible.list(java.io.PrintWriter)andtoString(). - Config.Separator - Annotation Type in org.aeonbits.owner
-
Specifies simple
as separator to tokenize properties values specified as a single string value, into elements for vectors and collections.String - Config.Sources - Annotation Type in org.aeonbits.owner
-
Specifies the source from which to load the properties file.
- Config.TokenizerClass - Annotation Type in org.aeonbits.owner
-
Specifies a
class to allow the user to define a custom logic to split the property value into tokens to be used as single elements for vectors and collections.Tokenizer - ConfigCache - Class in org.aeonbits.owner
-
Utility class caching Config instances that can be used as Singletons.
- ConfigFactory - Class in org.aeonbits.owner
-
A static factory class to instantiate
Configinstances. - ConfigValidationException - Exception Class in org.aeonbits.owner.validation
-
Thrown when a configuration is created and its values do not satisfy the constraints its methods declare.
- ConfigValidationException(Class<?>, List<Violation>) - Constructor for exception class org.aeonbits.owner.validation.ConfigValidationException
-
Builds an exception over the violations found in a configuration.
- ConfigValidator - Interface in org.aeonbits.owner.validation
-
Checks the constraint annotations of a configuration, which the core can see but cannot check.
- ConstrainedProperty - Class in org.aeonbits.owner.validation
-
One property to be checked: the method that carries the constraints, the key it resolved to, the value it answered with, and the configuration object it belongs to.
- ConstrainedProperty(Object, Method, String, Object) - Constructor for class org.aeonbits.owner.validation.ConstrainedProperty
-
Builds a property to be checked.
- Constraints - Class in org.aeonbits.owner.validation
-
Recognises a Bean Validation constraint by name, which is how the core can know that a configuration carries constraints while depending on no validation API at all.
- continuation() - Method in class org.aeonbits.owner.loaders.IniDialect
-
How a value may run onto the next line.
- CONVENTIONAL - Static variable in annotation type org.aeonbits.owner.Config.Sources
-
The source that stands for the convention: written among the sources of this annotation, it is replaced, in place, by everything this configuration would look for if it declared none - the files named after the mapping interface,
.propertiesfirst, then.xml,.iniand.cfg, then those offered by anyLoaderfound on the classpath. - convert(Method, String) - Method in interface org.aeonbits.owner.Converter
-
Converts the given input into an Object of type T.
- convert(Method, String) - Method in class org.aeonbits.owner.converters.ByteSizeConverter
- convert(Method, String) - Method in class org.aeonbits.owner.converters.DurationConverter
- Converter<T> - Interface in org.aeonbits.owner
-
Converter interface specifies how to convert an input string coming from a property value to a target object returned by the Config method.
- convertTo(ByteSizeUnit) - Method in class org.aeonbits.owner.util.bytesize.ByteSize
-
Creates a new
ByteSizerepresenting the same byte size but in a different unit. - create(Class<? extends T>, Map<?, ?>...) - Static method in class org.aeonbits.owner.ConfigFactory
-
Creates a
Configinstance from the specified interface - create(Class<? extends T>, Map<?, ?>...) - Method in interface org.aeonbits.owner.Factory
-
Creates a
Configinstance from the specified interface
D
- decrypt(String) - Method in interface org.aeonbits.owner.crypto.Decryptor
-
Decrypts a value.
- decrypt(String) - Method in class org.aeonbits.owner.crypto.IdentityDecryptor
- decrypt(String, String) - Method in class org.aeonbits.owner.crypto.AbstractDecryptor
- decrypt(String, String) - Method in interface org.aeonbits.owner.crypto.Decryptor
-
Decrypts a value, and when the value can not be decrypted returns a default value.
- Decryptor - Interface in org.aeonbits.owner.crypto
-
A decryptor is a class which is able to decrypt a value.
- DEFAULT_ITERATIONS - Static variable in class org.aeonbits.owner.handlers.AesGcmHandler
-
What a value is encrypted with today: OWASP's current guidance for PBKDF2-HMAC-SHA256.
- DEFAULT_NAME - Static variable in class org.aeonbits.owner.extras.jndi.JndiHandler
-
The name values refer to this handler by.
- DEFAULT_NAME - Static variable in class org.aeonbits.owner.handlers.AesGcmHandler
-
The name this handler answers to unless another is given.
- DEFAULT_NAME - Static variable in class org.aeonbits.owner.handlers.RsaHandler
-
The name this handler answers to unless another is given.
- DEFAULT_VALUE - Enum constant in enum org.aeonbits.owner.Origin.Kind
-
A
Config.DefaultValueon the method: nobody wrote this property, the interface did. - defaultSpecFor(String) - Method in class org.aeonbits.owner.extras.loaders.HoconLoader
- defaultSpecFor(String) - Method in class org.aeonbits.owner.extras.loaders.ZooKeeperLoader
- defaultSpecFor(String) - Method in class org.aeonbits.owner.formats.json.JsonLoader
- defaultSpecFor(String) - Method in class org.aeonbits.owner.formats.toml.TomlLoader
- defaultSpecFor(String) - Method in class org.aeonbits.owner.formats.yaml.YamlLoader
- defaultSpecFor(String) - Method in class org.aeonbits.owner.loaders.DotEnvLoader
-
Returns the default URI specification for a given URI resource, that can be handled by this loader.
- defaultSpecFor(String) - Method in interface org.aeonbits.owner.loaders.Loader
-
Returns the default URI specification for a given URI resource, that can be handled by this loader.
- defaultSpecFor(String) - Method in class org.aeonbits.owner.loaders.PropertiesLoader
- defaultSpecFor(String) - Method in class org.aeonbits.owner.loaders.SystemLoader
- defaultSpecFor(String) - Method in class org.aeonbits.owner.loaders.XMLLoader
- defaultSpecsFor(String) - Method in class org.aeonbits.owner.formats.yaml.YamlLoader
- defaultSpecsFor(String) - Method in class org.aeonbits.owner.loaders.IniLoader
-
Returns every default URI specification this loader offers, and is the one the library calls.
- defaultSpecsFor(String) - Method in interface org.aeonbits.owner.loaders.Loader
-
Returns every default URI specification this loader offers, and is the one the library calls.
- DELIMIT - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.Quotes
-
Delimiters, with
\n,\t,\b,\"and\\expanded inside them, as git config does. - Deriving once, not per value - Search tag in class org.aeonbits.owner.handlers.AesGcmHandler
- Section
- DOCKER - Static variable in class org.aeonbits.owner.loaders.EnvDialect
-
The rules of
docker run --env-file, and the default: quotes are part of the value, nothing is unescaped,#starts a comment only at the beginning of a line, and a bare name takes its value from the environment. - DOTENV - Static variable in class org.aeonbits.owner.loaders.EnvDialect
-
The rules of the
dotenvfamily — the Node, Python, Ruby and Go packages, anddotenv-java: quotes delimit, escape sequences are expanded inside double quotes, a leadingexportis dropped, a#preceded by whitespace starts a comment, and a quoted value may span lines. - DotEnvLoader - Class in org.aeonbits.owner.loaders
-
A
loaderable to read a.envfile, the format that container tooling has made the commonest way to carry configuration into a process. - DotEnvLoader() - Constructor for class org.aeonbits.owner.loaders.DotEnvLoader
-
Creates a loader reading in the
EnvDialect.DOCKERdialect. - DotEnvLoader(EnvDialect) - Constructor for class org.aeonbits.owner.loaders.DotEnvLoader
-
Creates a loader reading in the given dialect, which a query on a source can still override.
- duplicates() - Method in class org.aeonbits.owner.loaders.IniDialect
-
What a key repeated in one section means.
- DurationConverter - Class in org.aeonbits.owner.converters
-
A duration converter for the OWNER configuration system.
- DurationConverter() - Constructor for class org.aeonbits.owner.converters.DurationConverter
-
Built with no arguments: a converter named by
Config.ConverterClassis instantiated reflectively, so this constructor is part of the contract rather than an accident of there being no state. - DurationParser - Class in org.aeonbits.owner.util
-
Reads the duration strings that OWNER accepts, in either of two formats: the ISO-8601 format that
Duration.parse(CharSequence)supports, recognised by a leadingPwith an optional plus/minus prefix; a "value time_unit" string, wherevalueis an integer andtime_unitis one ofns,us,ms,s,m,h,dor one of their longer spellings.
E
- element(String, int) - Static method in class org.aeonbits.owner.loaders.PropertyKeys
-
The key of one element of a list:
portsand0giveports[0]. - encrypt(String) - Method in interface org.aeonbits.owner.crypto.Encryptor
-
Encrypts a value.
- encrypt(String) - Method in class org.aeonbits.owner.handlers.AesGcmHandler
-
Encrypts a value, producing the token that goes inside a marker.
- encrypt(String) - Method in class org.aeonbits.owner.handlers.RsaHandler
-
Encrypts a value, producing the token that goes inside a marker.
- encryptAll(String...) - Method in class org.aeonbits.owner.handlers.AesGcmHandler
-
Encrypts several values under one salt, so that reading them back costs one key derivation between them.
- encryptAll(String...) - Method in class org.aeonbits.owner.handlers.RsaHandler
-
Encrypts several values.
- Encryptor - Interface in org.aeonbits.owner.crypto
-
An encryptor is a class which is able to encrypt and decrypt a value.
- EncryptTool - Class in org.aeonbits.owner.handlers
-
Turns values into the markers that go in a configuration file, with either of the two ciphers.
- entry(K, V) - Static method in class org.aeonbits.owner.util.Collections
-
Creates a single map entry associating the given key with the given value.
- EnvDialect - Class in org.aeonbits.owner.loaders
-
The rules by which a
DotEnvLoaderreads a.envfile. - EnvDialect.BareNames - Enum in org.aeonbits.owner.loaders
-
What to make of a line that names a variable without assigning anything to it, as in a bare
HOMEon a line of its own. - equals(Object) - Method in class org.aeonbits.owner.handlers.AesGcmHandler
-
The passphrase is not part of what a handler is, and two of them are told apart by name.
- equals(Object) - Method in class org.aeonbits.owner.handlers.RsaHandler
-
Two handlers are told apart by name and by key pair, never by which halves they happen to hold.
- equals(Object) - Method in class org.aeonbits.owner.loaders.EnvDialect
- equals(Object) - Method in class org.aeonbits.owner.Origin
- equals(Object) - Method in class org.aeonbits.owner.util.bytesize.ByteSize
- EQUALS - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.Separator
-
Only
=, which is what git, systemd and the AWS credentials file use. - EQUALS_OR_COLON - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.Separator
-
Either
=or:, whichever comes first, as Python and Commons accept. - ERROR - Enum constant in enum org.aeonbits.owner.loaders.EnvDialect.BareNames
-
Refuse the file.
- ERROR - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.BareKeys
-
Refuse the file: a line that is neither a comment nor an assignment is malformed.
- ERROR - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.Duplicates
-
Refuse the file, naming the key and the line.
- Event - Class in org.aeonbits.owner.event
-
The root event class for all OWNER events.
- Event(Object) - Constructor for class org.aeonbits.owner.event.Event
-
Constructs a prototypical Event.
- EXABYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The SI exabyte.
- EXBIBYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The IEC exibyte.
- expandUserHome(String) - Static method in class org.aeonbits.owner.util.Util
-
Expands a leading
~in the given text to the user home directory, supporting plain,file:andjar:file:prefixes.
F
- Factory - Interface in org.aeonbits.owner
-
Interface for factory implementation used to instantiate
Configinstances. - fileFromURI(String) - Static method in class org.aeonbits.owner.util.Util
-
Resolves a
Filefrom the given URI string, retrying with backslashes converted to forward slashes if the initial parse fails. - fileFromURI(URI) - Static method in class org.aeonbits.owner.util.Util
- fill(Map) - Method in interface org.aeonbits.owner.Accessible
-
Fills the given
Mapwith the properties contained by this object. - FIRST - Enum constant in enum org.aeonbits.owner.Config.LoadType
-
The first available of the specified sources will be loaded.
- FIRST - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.Duplicates
-
Keep the first and ignore the rest.
- fixBackslashesToSlashes(String) - Static method in class org.aeonbits.owner.util.Util
-
Replaces backslashes with forward slashes in the given path.
- fixSpacesToPercentTwenty(String) - Static method in class org.aeonbits.owner.util.Util
-
Replaces spaces with
%20in the given path. - forName(String) - Static method in class org.aeonbits.owner.util.Reflection
-
Loads the class with the given name, returning
nullwhen it is not available. - FROM_ENVIRONMENT - Enum constant in enum org.aeonbits.owner.loaders.EnvDialect.BareNames
-
Take the value from the environment of the running process, and skip the line if it has none.
G
- get(Object) - Static method in class org.aeonbits.owner.ConfigCache
-
Gets from the cache the
Configinstance identified by the given key. - getBytes() - Method in class org.aeonbits.owner.util.bytesize.ByteSize
-
Returns the number of bytes that this byte size represents after multiplying the unit factor with the value.
- getBytesAsInt() - Method in class org.aeonbits.owner.util.bytesize.ByteSize
-
Returns the number of bytes that this byte size represents as an
intafter multiplying the unit factor with the value, throwing an exception if the result overflows anint. - getBytesAsLong() - Method in class org.aeonbits.owner.util.bytesize.ByteSize
-
Returns the number of bytes that this byte size represents as a
longafter multiplying the unit factor with the value, throwing an exception if the result overflows along. - getenv() - Method in interface org.aeonbits.owner.util.Util.SystemProvider
-
Returns the environment variables.
- getEvents() - Method in class org.aeonbits.owner.event.ReloadEvent
-
Returns The
change eventsregarding which properties have been modified during the reload. - getFactor() - Method in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
Gets the multiplication factor for this
ByteSizeUnit. - getKeys() - Method in exception class org.aeonbits.owner.MissingMandatoryPropertyException
-
Lists the keys of the mandatory properties that could not be resolved.
- getKeys() - Method in exception class org.aeonbits.owner.validation.ConfigValidationException
-
Lists the keys of the properties that failed a constraint, which is what a caller most often wants: the same key it would have read the value with.
- getNewProperties() - Method in class org.aeonbits.owner.event.ReloadEvent
-
Returns the properties after the reload.
- getOldProperties() - Method in class org.aeonbits.owner.event.ReloadEvent
-
Returns the properties before the reload.
- getOrCreate(Class<? extends T>, Map<?, ?>...) - Static method in class org.aeonbits.owner.ConfigCache
-
Gets from the cache or create, an instance of the given class using the given imports.
- getOrCreate(Object, Class<? extends T>, Map<?, ?>...) - Static method in class org.aeonbits.owner.ConfigCache
-
Gets from the cache or create, an instance of the given class using the given imports.
- getOrCreate(Factory, Class<? extends T>, Map<?, ?>...) - Static method in class org.aeonbits.owner.ConfigCache
-
Gets from the cache or create, an instance of the given class using the given imports.
- getOrCreate(Factory, Object, Class<? extends T>, Map<?, ?>...) - Static method in class org.aeonbits.owner.ConfigCache
-
Gets from the cache or create, an instance of the given class using the given imports.
- getProperties() - Static method in class org.aeonbits.owner.ConfigFactory
-
Those properties will be used to expand variables specified in the `@Source` annotation, or by the ConfigFactory to configure its own behavior.
- getProperties() - Method in interface org.aeonbits.owner.Factory
-
Those properties will be used to expand variables specified in the `@Source` annotation, or by the ConfigFactory to configure its own behavior.
- getProperties() - Method in interface org.aeonbits.owner.util.Util.SystemProvider
-
Returns a copy of the system properties.
- getProperty(String) - Method in interface org.aeonbits.owner.Accessible
-
Searches for the property with the specified key in this property list.
- getProperty(String) - Static method in class org.aeonbits.owner.ConfigFactory
-
Returns the value for a given property.
- getProperty(String) - Method in interface org.aeonbits.owner.Factory
-
Returns the value for a given property.
- getProperty(String) - Method in interface org.aeonbits.owner.util.Util.SystemProvider
-
Returns the system property for the given key.
- getProperty(String, String) - Method in interface org.aeonbits.owner.Accessible
-
Searches for the property with the specified key in this property list.
- getRawProperty(String) - Method in interface org.aeonbits.owner.Accessible
-
Searches for the property with the specified key and returns its value as it was written, with the variables left unexpanded.
- getRawProperty(String, String) - Method in interface org.aeonbits.owner.Accessible
-
Searches for the property with the specified key and returns its value as it was written, with the variables left unexpanded, or the given default when there is no such property.
- getTime() - Method in interface org.aeonbits.owner.util.Util.TimeProvider
-
Returns the current time in milliseconds.
- Getting a handler into a factory - Search tag in interface org.aeonbits.owner.handlers.ValueHandler
- Section
- Getting a loader into a factory - Search tag in interface org.aeonbits.owner.loaders.Loader
- Section
- getViolations() - Method in exception class org.aeonbits.owner.validation.ConfigValidationException
-
Lists the violations found.
- GIBIBYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The IEC gibibyte.
- GIGABYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The SI gigabyte.
- GIT - Static variable in class org.aeonbits.owner.loaders.IniDialect
-
The rules of
git config: a subsection in the section header, quotes that delimit and escapes inside them, a comment that may follow a value, a backslash that continues a line, and a bare key that means true.
H
- hasExtension(URI, String...) - Static method in class org.aeonbits.owner.loaders.SourceOptions
-
Whether a source ends in one of the given extensions, which is what most
Loader.accept(URI)implementations amount to. - hashCode() - Method in class org.aeonbits.owner.handlers.AesGcmHandler
- hashCode() - Method in class org.aeonbits.owner.handlers.RsaHandler
- hashCode() - Method in class org.aeonbits.owner.loaders.EnvDialect
- hashCode() - Method in class org.aeonbits.owner.Origin
- hashCode() - Method in class org.aeonbits.owner.util.bytesize.ByteSize
-
Derived from the same number of bytes
ByteSize.equals(Object)compares, and from nothing else: two sizes that are equal because they are the same amount written in different units, or with a different number of decimals, have to agree on the hash code as well, or the type does not work as a key of aHashMapnor as an element of aHashSet. - Held to the conformance suite - Search tag in class org.aeonbits.owner.formats.toml.TomlLoader
- Section
- hideCredentials(URI) - Static method in class org.aeonbits.owner.util.Util
-
The text of a source, with any credentials in it replaced.
- HoconLoader - Class in org.aeonbits.owner.extras.loaders
- HoconLoader() - Constructor for class org.aeonbits.owner.extras.loaders.HoconLoader
-
A loader is built with no arguments, both when it is registered by hand and when
ServiceLoaderfinds it on the class path.
I
- IdentityDecryptor - Class in org.aeonbits.owner.crypto
-
IdentityDecryptor is a no-op decryptor: it accepts a value and returns the same value for both decrypting and encrypting.
- IdentityDecryptor() - Constructor for class org.aeonbits.owner.crypto.IdentityDecryptor
-
Built with no arguments, because it is named by an annotation and instantiated reflectively - and because there is nothing to configure about doing nothing.
- IEC - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeStandard
-
The International Electrotechnical Commission (IEC) standard.
- ignore() - Static method in class org.aeonbits.owner.util.Util
-
no operation
- IGNORE - Enum constant in enum org.aeonbits.owner.loaders.EnvDialect.BareNames
-
Skip the line.
- IGNORE - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.BareKeys
-
Skip the line.
- ignoreAndReturnNull() - Static method in class org.aeonbits.owner.util.Util
-
Does nothing and returns
null; used to silence reporting tools complaining about empty catch blocks while making the intent explicit. - IMPORT - Enum constant in enum org.aeonbits.owner.Origin.Kind
-
One of the maps handed to
ConfigFactory.create(Class, java.util.Map[]). - in(ByteSizeStandard) - Method in class org.aeonbits.owner.util.bytesize.ByteSize
-
Returns the same byte size expressed in the unit of the given standard that makes it readable: the largest one in which the value does not fall below one, so that 2048576 bytes read as
2.048576 MBinByteSizeStandard.SIand as1.95367431640625 MiBinByteSizeStandard.IEC. - INDENT - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.Continuation
-
A line indented more deeply than the key joins the value, as Python allows.
- INDEX_CLOSE - Static variable in class org.aeonbits.owner.loaders.PropertyKeys
-
And the character closing it.
- INDEX_OPEN - Static variable in class org.aeonbits.owner.loaders.PropertyKeys
-
Around the index of an element.
- INI - Static variable in class org.aeonbits.owner.loaders.IniDialect
-
The conservative common denominator, and the default.
- IniDialect - Class in org.aeonbits.owner.loaders
-
The rules by which an
IniLoaderreads an INI file. - IniDialect.BareKeys - Enum in org.aeonbits.owner.loaders
-
What to make of a name on a line of its own, with no separator after it.
- IniDialect.Continuation - Enum in org.aeonbits.owner.loaders
-
How a value may be continued on the line after it.
- IniDialect.Duplicates - Enum in org.aeonbits.owner.loaders
-
What to make of a key that appears more than once in the same section.
- IniDialect.KeyCase - Enum in org.aeonbits.owner.loaders
-
Whether a key is taken as written or folded.
- IniDialect.Quotes - Enum in org.aeonbits.owner.loaders
-
Whether the quotes around a value delimit it or belong to it.
- IniDialect.Separator - Enum in org.aeonbits.owner.loaders
-
What separates a key from its value.
- IniLoader - Class in org.aeonbits.owner.loaders
-
A
loaderfor INI files: sections in square brackets,key = valuebelow them. - IniLoader() - Constructor for class org.aeonbits.owner.loaders.IniLoader
-
Creates a loader reading in the
IniDialect.INIdialect. - IniLoader(IniDialect) - Constructor for class org.aeonbits.owner.loaders.IniLoader
-
Creates a loader reading in the given dialect, which an option on a source can still override.
- interval() - Element in annotation type org.aeonbits.owner.Config.HotReload
-
The same interval written as text, so that it can come from outside the source file: a
${variable}here is expanded from the properties given to theFactory, the system properties and the environment — the same three, in the same order, that expand aConfig.Sourcesspec. - invokeDefaultMethod(Object, Method, Object[]) - Static method in class org.aeonbits.owner.util.Reflection
-
Invokes a
defaultmethod on the given proxy, dispatching to the interface implementation instead of going through the proxy invocation handler. - isClassAvailable(String) - Static method in class org.aeonbits.owner.util.Reflection
-
Checks whether a class with the given name is available on the classpath.
- isConstraint(Class<? extends Annotation>) - Static method in class org.aeonbits.owner.validation.Constraints
-
Tells whether the given annotation type is a Bean Validation constraint.
- isDefault(Method) - Static method in class org.aeonbits.owner.util.Reflection
-
Tells whether the given method is an interface
defaultmethod. - isDefaultSectionInherited() - Method in class org.aeonbits.owner.loaders.IniDialect
-
Whether a
DEFAULTsection supplies values to the others. - isDisabledFor(Class<?>) - Method in enum org.aeonbits.owner.Config.DisableableFeature
-
Tells whether this feature is disabled for a configuration object as a whole: the annotation is looked for on the given interface and on every interface above it, nearest first.
- isDisabledFor(Method) - Method in enum org.aeonbits.owner.Config.DisableableFeature
-
Tells whether this feature is disabled for the given method, considering the
Config.DisableFeatureannotation on the method itself and on the interface declaring it. - isEmpty() - Method in class org.aeonbits.owner.loaders.SourceOptions
-
Whether the source carries no option at all.
- isEscapesExpanded() - Method in class org.aeonbits.owner.loaders.EnvDialect
-
Whether escape sequences are expanded inside a double-quoted value.
- isExportPrefixStripped() - Method in class org.aeonbits.owner.loaders.EnvDialect
-
Whether a leading
exportis dropped. - isIEC() - Method in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
Returns whether this
ByteSizeUnitis an IEC unit. - isInlineComments() - Method in class org.aeonbits.owner.loaders.EnvDialect
-
Whether a
#preceded by whitespace starts a comment. - isInlineComments() - Method in class org.aeonbits.owner.loaders.IniDialect
-
Whether a comment may follow a value.
- isInterpolationRefused() - Method in class org.aeonbits.owner.loaders.IniDialect
-
Whether a value holding
%(name)sis refused. - isIso8601(String) - Static method in class org.aeonbits.owner.util.DurationParser
-
Tells whether the given text is an ISO-8601 duration, and so is read by
Duration.parse(CharSequence)rather than by thevalue time_unitrules. - isLineContinuation() - Method in class org.aeonbits.owner.loaders.EnvDialect
-
Whether a line ending in a backslash is joined to the next.
- isMultilineValues() - Method in class org.aeonbits.owner.loaders.EnvDialect
-
Whether a quoted value may span lines.
- isQuotesStripped() - Method in class org.aeonbits.owner.loaders.EnvDialect
-
Whether matching quotes around a value are removed.
- isRequired(URI) - Static method in class org.aeonbits.owner.loaders.SourceOptions
-
Whether the source says it has to be there.
- isSI() - Method in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
Returns whether this
ByteSizeUnitis an SI unit. - isSubsections() - Method in class org.aeonbits.owner.loaders.IniDialect
-
Whether a quoted name in a section header is a subsection.
- isWritten() - Method in class org.aeonbits.owner.Origin
-
Tells whether the property was written somewhere rather than declared by the interface, which is the distinction the loaded properties can no longer make on their own: a default and a value read from a file are the same property once they are merged.
- It is a subset, and this is the whole of it - Search tag in class org.aeonbits.owner.formats.yaml.YamlLoader
- Section
J
- javax or jakarta: both, and why - Search tag in class org.aeonbits.owner.extras.validation.BeanValidator
- Section
- JndiHandler - Class in org.aeonbits.owner.extras.jndi
-
Reads a single JNDI entry into a value:
- JndiHandler() - Constructor for class org.aeonbits.owner.extras.jndi.JndiHandler
-
A handler under the name
jndi, against the ambient JNDI environment. - JndiHandler(String, Map<?, ?>) - Constructor for class org.aeonbits.owner.extras.jndi.JndiHandler
-
A handler under a name of your own, which is how two providers are readable at once.
- JndiHandler(Map<?, ?>) - Constructor for class org.aeonbits.owner.extras.jndi.JndiHandler
-
A handler against a JNDI environment of your own.
- JndiLoader - Class in org.aeonbits.owner.extras.jndi
-
A
loaderthat reads the properties bound under a JNDI context: - JndiLoader() - Constructor for class org.aeonbits.owner.extras.jndi.JndiLoader
-
A loader is built with no arguments, both when it is registered by hand and when
ServiceLoaderfinds it on the class path. - JndiLoader(Map<?, ?>) - Constructor for class org.aeonbits.owner.extras.jndi.JndiLoader
-
A loader against a JNDI environment of your own, which is how a provider somewhere else is reached.
- JsonLoader - Class in org.aeonbits.owner.formats.json
-
A
loaderfor JSON, reading a source whose path ends in.json. - JsonLoader() - Constructor for class org.aeonbits.owner.formats.json.JsonLoader
-
A loader is built with no arguments, both when it is registered by hand and when
ServiceLoaderfinds it on the class path.
K
- key() - Method in class org.aeonbits.owner.validation.ConstrainedProperty
-
The key this property resolved to, which is what a violation should be reported against: it is the line the reader has to go and change, while the method name is only where it is declared.
- key() - Method in class org.aeonbits.owner.validation.Violation
-
The key of the property that failed.
- keyCase() - Method in class org.aeonbits.owner.loaders.IniDialect
-
Whether a key is folded to lower case.
- KIBIBYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The IEC kibibyte.
- KILOBYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The SI kilobyte.
- kind() - Method in class org.aeonbits.owner.Origin
-
What kind of place the property came from.
L
- LAST - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.Duplicates
-
Keep the last, which is what the AWS SDK for Java does.
- list() - Static method in class org.aeonbits.owner.ConfigCache
-
Lists the key objects for all configuration instances present in the cache.
- list(E...) - Static method in class org.aeonbits.owner.util.Collections
-
Creates a list from the given elements.
- list(PrintStream) - Method in interface org.aeonbits.owner.Accessible
-
Prints this property list out to the specified output stream.
- list(PrintWriter) - Method in interface org.aeonbits.owner.Accessible
-
Prints this property list out to the specified output stream.
- LIST - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.Duplicates
-
Number them, as repeated XML elements are numbered:
host[0],host[1]. - LITERAL - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.KeyCase
-
As written.
- LITERAL - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.Quotes
-
Part of the value.
- load(InputStream) - Method in interface org.aeonbits.owner.Mutable
-
Reads a property list (key and element pairs) from the input byte stream.
- load(Reader) - Method in interface org.aeonbits.owner.Mutable
-
Reads a property list (key and element pairs) from the input character stream in a simple line-oriented format.
- load(Properties, InputStream) - Method in class org.aeonbits.owner.loaders.XMLLoader
-
The same reading, from a stream that is already open, for a caller who has the bytes and no URI to name them with -
Mutable.loadFromXML(InputStream). - load(Properties, URI) - Method in class org.aeonbits.owner.extras.jndi.JndiLoader
- load(Properties, URI) - Method in class org.aeonbits.owner.extras.loaders.HoconLoader
- load(Properties, URI) - Method in class org.aeonbits.owner.extras.loaders.ZooKeeperLoader
- load(Properties, URI) - Method in class org.aeonbits.owner.formats.json.JsonLoader
- load(Properties, URI) - Method in class org.aeonbits.owner.formats.toml.TomlLoader
- load(Properties, URI) - Method in class org.aeonbits.owner.formats.yaml.YamlLoader
- load(Properties, URI) - Method in class org.aeonbits.owner.loaders.DotEnvLoader
- load(Properties, URI) - Method in class org.aeonbits.owner.loaders.IniLoader
- load(Properties, URI) - Method in interface org.aeonbits.owner.loaders.Loader
- load(Properties, URI) - Method in class org.aeonbits.owner.loaders.PropertiesLoader
- load(Properties, URI) - Method in class org.aeonbits.owner.loaders.SystemLoader
- load(Properties, URI) - Method in class org.aeonbits.owner.loaders.XMLLoader
-
Reads the document, holding it to the grammar it declares.
- Loader - Interface in org.aeonbits.owner.loaders
-
Defines the interface of a generic Properties loader.
- loadFromXML(InputStream) - Method in interface org.aeonbits.owner.Mutable
-
Reads a property list from an XML document, the way this library reads one from a source and not the way
Properties.loadFromXML(InputStream)does. - LOWER - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.KeyCase
-
Lower case, as Python's
optionxformdoes - to the keys, and not to the sections.
M
- main(String[]) - Static method in class org.aeonbits.owner.handlers.EncryptTool
-
The entry point, and the only thing in this jar that has one.
- main(String[]) - Static method in class org.aeonbits.owner.TemplateTool
- map(Map.Entry<? extends K, ? extends V>...) - Static method in class org.aeonbits.owner.util.Collections
-
Creates a map from the given entries.
- map(K, V) - Static method in class org.aeonbits.owner.util.Collections
-
Creates a map containing a single entry associating the given key with the given value.
- marker(String) - Method in class org.aeonbits.owner.handlers.AesGcmHandler
-
The marker wrapping an already encrypted token.
- marker(String) - Method in class org.aeonbits.owner.handlers.RsaHandler
-
The marker wrapping an already encrypted token.
- markerFor(String) - Method in class org.aeonbits.owner.handlers.AesGcmHandler
-
The whole marker for a value, which is what gets pasted into a configuration file:
${$aes-gcm::...}. - markerFor(String) - Method in class org.aeonbits.owner.handlers.RsaHandler
-
The whole marker for a value, which is what gets pasted into a configuration file.
- MASK - Static variable in annotation type org.aeonbits.owner.Config.Sensitive
-
The text printed in place of the value of a sensitive property.
- MAXIMUM_ITERATIONS - Static variable in class org.aeonbits.owner.handlers.AesGcmHandler
-
The highest count a token may carry, which is a bound on damage rather than on cryptography.
- MEBIBYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The IEC mebibyte.
- MEGABYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The SI megabyte.
- MERGE - Enum constant in enum org.aeonbits.owner.Config.LoadType
-
All the specified sources will be loaded and merged.
- message() - Method in class org.aeonbits.owner.validation.Violation
-
What the validation provider said about it, in the provider's own words and language.
- method() - Method in class org.aeonbits.owner.validation.ConstrainedProperty
-
The method carrying the constraints.
- methodName() - Method in class org.aeonbits.owner.validation.Violation
-
The name of the method the constraint is written on.
- MINIMUM_ITERATIONS - Static variable in class org.aeonbits.owner.handlers.AesGcmHandler
-
The lowest count a token may carry and still be read.
- MINIMUM_KEY_BITS - Static variable in class org.aeonbits.owner.handlers.RsaHandler
-
The smallest modulus this handler will use, in bits.
- MissingMandatoryPropertyException - Exception Class in org.aeonbits.owner
-
Thrown when a property marked as
Config.Mandatorycannot be resolved: at creation time, listing all the missing keys, or at access time when the property has become unavailable. - Mutable - Interface in org.aeonbits.owner
-
Allows a
Configobject to change its property values at runtime.
N
- name() - Method in class org.aeonbits.owner.extras.jndi.JndiHandler
- name() - Method in class org.aeonbits.owner.handlers.AesGcmHandler
- name() - Method in class org.aeonbits.owner.handlers.RsaHandler
- name() - Method in interface org.aeonbits.owner.handlers.ValueHandler
-
The name this handler answers to, which is what appears between
${$and::. - name() - Method in class org.aeonbits.owner.loaders.EnvDialect
-
The name of the dialect this one is derived from.
- name() - Method in class org.aeonbits.owner.loaders.IniDialect
-
The name this dialect goes by, for a message that has to say which rules were in force.
- name() - Method in class org.aeonbits.owner.loaders.SourceOptions.Option
-
The option name, trimmed and lower case, since a name is a keyword.
- named(String) - Static method in class org.aeonbits.owner.loaders.EnvDialect
-
Returns the named dialect:
docker,dotenvorcompose. - named(String) - Static method in class org.aeonbits.owner.loaders.IniDialect
-
Returns the named dialect:
ini,gitorpython. - NESTING - Static variable in class org.aeonbits.owner.loaders.PropertyKeys
-
Between a parent and its child.
- newInstance() - Static method in class org.aeonbits.owner.ConfigFactory
-
Returns a new instance of a config Factory object.
- newInstance(Class<? extends T>[], List<T>) - Static method in class org.aeonbits.owner.util.Util
-
Instantiates each of the given classes and appends the instances to the given list.
- newInstance(Class<T>) - Static method in class org.aeonbits.owner.util.Util
-
Instantiates the given class using its no-argument constructor, whatever its visibility and whatever the visibility of the class itself.
- NONE - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.Continuation
-
It may not.
- Nothing secret is an argument - Search tag in class org.aeonbits.owner.handlers.EncryptTool
- Section
- now() - Static method in class org.aeonbits.owner.util.Util
-
Returns the current time in milliseconds, as provided by the configured
Util.TimeProvider.
O
- of(URI) - Static method in class org.aeonbits.owner.loaders.SourceOptions
-
Reads the options written on a source.
- One run, one salt — for the symmetric cipher - Search tag in class org.aeonbits.owner.handlers.EncryptTool
- Section
- Options on a source - Search tag in interface org.aeonbits.owner.loaders.Loader
- Section
- org.aeonbits.owner - package org.aeonbits.owner
-
The goal of OWNER API is to minimize the code required to handle application configuration through Java properties files.
- org.aeonbits.owner.converters - package org.aeonbits.owner.converters
- org.aeonbits.owner.crypto - package org.aeonbits.owner.crypto
-
The seam through which a decryptor of yours is called: what
Config.EncryptedValueandConfig.DecryptorClassname, and the base classes that save an implementation from writing the same two methods. - org.aeonbits.owner.event - package org.aeonbits.owner.event
-
Provides interfaces and classes for dealing with different types of events fired by OWNER components.
- org.aeonbits.owner.extras.jndi - package org.aeonbits.owner.extras.jndi
-
Reading a configuration out of JNDI, which is where an application server keeps what it was told about the application: as a whole context through
JndiLoader, or one entry at a time throughJndiHandler. - org.aeonbits.owner.extras.loaders - package org.aeonbits.owner.extras.loaders
-
The loaders that cannot be written without somebody else's library on the class path: HOCON, which reads an
application.confthrough Typesafe Config, and ZooKeeper, which reads a node through Curator. - org.aeonbits.owner.extras.validation - package org.aeonbits.owner.extras.validation
-
The Bean Validation provider the core looks for: what makes
@Min,@NotNulland the rest mean something on a method named the way this library teaches. - org.aeonbits.owner.formats.json - package org.aeonbits.owner.formats.json
-
Reads a configuration written in JSON - a source whose path ends in
.json- flattening it into the keys the rest of the library already speaks:server.host,servers[0].host. - org.aeonbits.owner.formats.toml - package org.aeonbits.owner.formats.toml
-
Reads a configuration written in TOML v1.0.0 - a source whose path ends in
.toml- flattening it into the keys the rest of the library already speaks. - org.aeonbits.owner.formats.yaml - package org.aeonbits.owner.formats.yaml
-
Reads a configuration written in YAML - a source whose path ends in
.yamlor.yml- flattening it into the keys the rest of the library already speaks. - org.aeonbits.owner.handlers - package org.aeonbits.owner.handlers
-
Provides the interface of a value handler, which resolves a
${$name::payload}marker into the value that replaces it, and the handlers OWNER ships. - org.aeonbits.owner.loaders - package org.aeonbits.owner.loaders
-
Provides interfaces and classes to allow OWNER to load properties from several file formats.
- org.aeonbits.owner.util - package org.aeonbits.owner.util
-
Provides utility interfaces and classes.
- org.aeonbits.owner.util.bytesize - package org.aeonbits.owner.util.bytesize
-
A size in bytes as a type rather than as a number:
10 MBread as what it says, in both the standards that phrase means. - org.aeonbits.owner.validation - package org.aeonbits.owner.validation
-
The seam through which a Bean Validation provider checks a configuration, and the vocabulary the core uses to talk about constraints without depending on a validation API.
- Origin - Class in org.aeonbits.owner
-
Where a property came from: which of the
sourcesproduced it, or whether it was an import, aConfig.DefaultValueor something written at run time. - Origin.Kind - Enum in org.aeonbits.owner
-
What kind of place a property came from.
- originOf(String) - Method in interface org.aeonbits.owner.Traceable
-
Returns where the given property came from.
- origins() - Method in interface org.aeonbits.owner.Traceable
-
Returns where every property came from.
P
- PARAMETER_FORMATTING - Enum constant in enum org.aeonbits.owner.Config.DisableableFeature
-
Disables parameter formatting, i.e. the
Formattersubstitution of a method's arguments into its value —%sand%d, asString.format(java.lang.String, java.lang.Object...)does. - parse(String) - Static method in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
Parses a string representation of a byte size unit and returns the corresponding
ByteSizeUnit. - parse(String) - Static method in class org.aeonbits.owner.util.DurationParser
-
Reads a duration in either of the two supported formats.
- path(URI) - Static method in class org.aeonbits.owner.loaders.SourceOptions
-
The part of a source to match an extension against: no query, no fragment, and no assumption that the URI is hierarchical.
- PEBIBYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The IEC pebibyte.
- PETABYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The SI petabyte.
- PREFIX - Enum constant in enum org.aeonbits.owner.Config.DisableableFeature
-
Disables the
Config.Prefixdeclared on the interface, so that the annotated method — or every method of the annotated interface — is looked up with its bare key. - Preprocessor - Interface in org.aeonbits.owner
-
Preprocessor interface specifies how to pre-process an input string coming from a property value before being used by OWNER.
- privateKeyFrom(String) - Static method in class org.aeonbits.owner.handlers.RsaHandler
-
Reads a private key from PKCS#8 PEM - a
PRIVATE KEYblock, which is whatopenssl genpkeywrites. - privateKeyFrom(Path) - Static method in class org.aeonbits.owner.handlers.RsaHandler
-
Reads a private key from a PKCS#8 PEM file.
- process(String) - Method in interface org.aeonbits.owner.Preprocessor
-
Pre-processes the given input string before it is used by the library.
- processAbsent(String) - Method in interface org.aeonbits.owner.Preprocessor
-
Called instead of
Preprocessor.process(String)when the property is absent — no value in any source and noConfig.DefaultValue— so that a preprocessor can supply one, or refuse. - PropertiesLoader - Class in org.aeonbits.owner.loaders
-
A
loaderable to read properties from standard Java properties files. - PropertiesLoader() - Constructor for class org.aeonbits.owner.loaders.PropertiesLoader
-
A loader is built with no arguments, both when it is registered by hand and when
ServiceLoaderfinds it on the class path. - PropertyKeys - Class in org.aeonbits.owner.loaders
-
How a tree becomes flat property keys, in one place.
- propertyNames() - Method in interface org.aeonbits.owner.Accessible
-
Returns a set of keys in this property list including distinct keys in the default property list if a key of the same name has not already been found from the main properties list.
- publicKeyFrom(String) - Static method in class org.aeonbits.owner.handlers.RsaHandler
-
Reads a public key from PEM, in any of the three shapes somebody is likely to have: a
PUBLIC KEYblock, aCERTIFICATEblock - which is what a keystore exports - or the base64 of either with the header lines missing. - publicKeyFrom(Path) - Static method in class org.aeonbits.owner.handlers.RsaHandler
-
Reads a public key from a PEM file.
- PYTHON - Static variable in class org.aeonbits.owner.loaders.IniDialect
-
The rules of Python's
configparser, as far as they can be honoured::accepted beside=, keys folded to lower case, a duplicate key refused, a value continued by indentation, and the[DEFAULT]section inherited by every other one.
Q
- quotes() - Method in class org.aeonbits.owner.loaders.IniDialect
-
Whether quotes around a value delimit it.
R
- Reflection - Class in org.aeonbits.owner.util
-
The reflection this library needs and the JDK differences behind it: whether a method is a
defaultone, how to invoke it on each baseline, and whether a class is on the class path. - refuseUnknown(String...) - Method in class org.aeonbits.owner.loaders.SourceOptions
-
Refuses every option whose name is not in the given list.
- registerLoader(Loader) - Static method in class org.aeonbits.owner.ConfigFactory
-
Registers a loader to enables additional file formats.
- registerLoader(Loader) - Method in interface org.aeonbits.owner.Factory
-
Registers a loader to enables additional file formats.
- registerValueHandler(ValueHandler) - Static method in class org.aeonbits.owner.ConfigFactory
-
Registers a handler a value can name, as
${$name::payload}, instead of holding its own text. - registerValueHandler(ValueHandler) - Method in interface org.aeonbits.owner.Factory
-
Registers a handler a value can name, as
${$name::payload}, instead of holding its own text. - RELAXED_BINDING - Enum constant in enum org.aeonbits.owner.Config.DisableableFeature
-
Disables the relaxed binding, so that the annotated method — or every method of the annotated interface — reads the key it resolves to and no other spelling of it.
- reload() - Method in interface org.aeonbits.owner.Reloadable
-
Reloads the properties using the same logic as when the object was instantiated by
ConfigFactory.create(Class, java.util.Map[]). - Reloadable - Interface in org.aeonbits.owner
-
Allows a
Configobject to implement the reloading of the properties at runtime. - ReloadEvent - Class in org.aeonbits.owner.event
-
A semantic event which indicates that a reload occurred.
- ReloadEvent(Object, List<PropertyChangeEvent>, Properties, Properties) - Constructor for class org.aeonbits.owner.event.ReloadEvent
-
Constructs a prototypical Event.
- ReloadListener - Interface in org.aeonbits.owner.event
-
The listener interface for receiving reload events.
- reloadPerformed(ReloadEvent) - Method in interface org.aeonbits.owner.event.ReloadListener
-
This method is invoked after the property are reloaded.
- remove(Object) - Static method in class org.aeonbits.owner.ConfigCache
-
Removes the cached instance for the given key if it is present.
- removeProperty(String) - Method in interface org.aeonbits.owner.Mutable
-
Removes a given property.
- removePropertyChangeListener(PropertyChangeListener) - Method in interface org.aeonbits.owner.Mutable
-
Removes a
PropertyChangeListenerfrom the Mutable interface. - removeReloadListener(ReloadListener) - Method in interface org.aeonbits.owner.Reloadable
-
Remove a ReloadListener.
- removeTypeConverter(Class<?>) - Static method in class org.aeonbits.owner.ConfigFactory
-
Removes a converter for the given type.
- removeTypeConverter(Class<?>) - Method in interface org.aeonbits.owner.Factory
-
Removes a converter for the given type, from this factory: see
Factory.setTypeConverter(java.lang.Class<?>, java.lang.Class<? extends org.aeonbits.owner.Converter<?>>). - REQUIRED - Static variable in class org.aeonbits.owner.loaders.SourceOptions
-
The option that says a source has to be there, read by the library rather than by a loader.
- resolve(String) - Method in class org.aeonbits.owner.extras.jndi.JndiHandler
-
Looks the name up and answers with the value bound to it.
- resolve(String) - Method in class org.aeonbits.owner.handlers.AesGcmHandler
-
Decrypts a token, which is the payload of the marker naming this handler.
- resolve(String) - Method in class org.aeonbits.owner.handlers.RsaHandler
-
Decrypts a token, which is the payload of the marker naming this handler.
- resolve(String) - Method in interface org.aeonbits.owner.handlers.ValueHandler
-
Resolves the payload of a marker into the value that replaces it.
- reverse(List<T>) - Static method in class org.aeonbits.owner.util.Util
-
Returns a reversed copy of the given list, leaving the original untouched.
- reverse(T[]) - Static method in class org.aeonbits.owner.util.Util
-
Returns a reversed copy of the given array, leaving the original untouched.
- RollbackBatchException - Exception Class in org.aeonbits.owner.event
-
Indicates that whole batch of event must be rolled back.
- RollbackBatchException() - Constructor for exception class org.aeonbits.owner.event.RollbackBatchException
-
Constructs a new exception with no detail message.
- RollbackBatchException(String) - Constructor for exception class org.aeonbits.owner.event.RollbackBatchException
-
Constructs a new exception with the given detail message.
- RollbackBatchException(String, Throwable) - Constructor for exception class org.aeonbits.owner.event.RollbackBatchException
-
Constructs a new exception with the given detail message and cause.
- RollbackBatchException(Throwable) - Constructor for exception class org.aeonbits.owner.event.RollbackBatchException
-
Constructs a new exception with the given cause.
- RollbackException - Exception Class in org.aeonbits.owner.event
-
Superclass for event rollback.
- RollbackException() - Constructor for exception class org.aeonbits.owner.event.RollbackException
-
Constructs a new exception with no detail message.
- RollbackException(String) - Constructor for exception class org.aeonbits.owner.event.RollbackException
-
Constructs a new exception with the given detail message.
- RollbackException(String, Throwable) - Constructor for exception class org.aeonbits.owner.event.RollbackException
-
Constructs a new exception with the given detail message and cause.
- RollbackException(Throwable) - Constructor for exception class org.aeonbits.owner.event.RollbackException
-
Constructs a new exception with the given cause.
- RollbackOperationException - Exception Class in org.aeonbits.owner.event
-
Indicates that operation must be rolled back.
- RollbackOperationException() - Constructor for exception class org.aeonbits.owner.event.RollbackOperationException
-
Constructs a new exception with no detail message.
- RollbackOperationException(String) - Constructor for exception class org.aeonbits.owner.event.RollbackOperationException
-
Constructs a new exception with the given detail message.
- RollbackOperationException(String, Throwable) - Constructor for exception class org.aeonbits.owner.event.RollbackOperationException
-
Constructs a new exception with the given detail message and cause.
- RollbackOperationException(Throwable) - Constructor for exception class org.aeonbits.owner.event.RollbackOperationException
-
Constructs a new exception with the given cause.
- Rotation - Search tag in class org.aeonbits.owner.handlers.AesGcmHandler
- Section
- Rotation, and serialization - Search tag in class org.aeonbits.owner.handlers.RsaHandler
- Section
- RsaHandler - Class in org.aeonbits.owner.handlers
-
The asymmetric cipher: RSA-OAEP over AES-256/GCM, behind the name
rsa-oaep. - RsaHandler(String, PublicKey, PrivateKey) - Constructor for class org.aeonbits.owner.handlers.RsaHandler
-
A handler under a name of your own, holding either half of a key pair or both.
- RsaHandler(PrivateKey) - Constructor for class org.aeonbits.owner.handlers.RsaHandler
-
A handler that can only read: the case of a deployment, and the reason a key pair is used at all.
- RsaHandler(PublicKey) - Constructor for class org.aeonbits.owner.handlers.RsaHandler
-
A handler that can only write: the case of whoever adds a value without being able to read one.
- RsaHandler(PublicKey, PrivateKey) - Constructor for class org.aeonbits.owner.handlers.RsaHandler
-
A handler that can do both, which is convenient in a test and rarely what a deployment wants.
- RUNTIME - Enum constant in enum org.aeonbits.owner.Origin.Kind
-
Written after the configuration was loaded, through
Mutable.
S
- save(File) - Method in interface org.aeonbits.owner.Accessible
-
Writes this configuration to a properties file, keeping the file that is already there.
- separator() - Method in class org.aeonbits.owner.loaders.IniDialect
-
What separates a key from its value.
- Serialization - Search tag in class org.aeonbits.owner.handlers.AesGcmHandler
- Section
- Serialization - Search tag in interface org.aeonbits.owner.loaders.Loader
- Section
- set(E...) - Static method in class org.aeonbits.owner.util.Collections
-
Creates a set from the given elements, preserving their iteration order.
- setProperties(Properties) - Static method in class org.aeonbits.owner.ConfigFactory
-
Those properties will be used to expand variables specified in the `@Source` annotation, or by the ConfigFactory to configure its own behavior.
- setProperties(Properties) - Method in interface org.aeonbits.owner.Factory
-
Those properties will be used to expand variables specified in the `@Source` annotation, or by the ConfigFactory to configure its own behavior.
- setProperty(String, String) - Static method in class org.aeonbits.owner.ConfigFactory
-
Set a property in the ConfigFactory.
- setProperty(String, String) - Method in interface org.aeonbits.owner.Factory
-
Set a property in the ConfigFactory.
- setProperty(String, String) - Method in interface org.aeonbits.owner.Mutable
-
Sets a given property to the specified value.
- setting() - Method in class org.aeonbits.owner.loaders.SourceOptions.Option
-
The setting, trimmed and otherwise exactly as written: no case folding and no percent decoding.
- setTypeConverter(Class<?>, Class<? extends Converter<?>>) - Static method in class org.aeonbits.owner.ConfigFactory
-
Sets a converter for the given type.
- setTypeConverter(Class<?>, Class<? extends Converter<?>>) - Method in interface org.aeonbits.owner.Factory
-
Sets a converter for the given type.
- setTypeConverter(Class<?>, Converter<?>) - Static method in class org.aeonbits.owner.ConfigFactory
-
Sets a converter for the given type on the default factory, as an object rather than as a class, which is how a converter built by a dependency injection container is registered.
- setTypeConverter(Class<?>, Converter<?>) - Method in interface org.aeonbits.owner.Factory
-
Sets a converter for the given type, as an object rather than as a class.
- SI - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeStandard
-
The International System of Units (SI) standard.
- Since 2.0.0 there is a second way, and it is the one to prefer - Search tag in annotation type org.aeonbits.owner.Config.EncryptedValue
- Section
- source() - Method in class org.aeonbits.owner.Origin
-
The source that produced the property, as it was written in
Config.Sourcesand with any credentials masked, or the position of the import that carried it. - SOURCE - Enum constant in enum org.aeonbits.owner.Origin.Kind
-
One of the
Config.Sources, named byOrigin.source(). - SourceOptions - Class in org.aeonbits.owner.loaders
-
The options written on a single source, and the one place every
Loaderreads them from. - SourceOptions.Option - Class in org.aeonbits.owner.loaders
-
One
name=settingpair written on a source. - splitNumericAndChar(String) - Static method in class org.aeonbits.owner.util.Util
-
Splits a string into a numeric part and a character part.
- store(OutputStream, String) - Method in interface org.aeonbits.owner.Accessible
-
Stores the underlying properties into an
OutputStream. - store(Writer, String) - Method in interface org.aeonbits.owner.Accessible
-
Stores the underlying properties into a
Writer. - storeToXML(OutputStream, String) - Method in interface org.aeonbits.owner.Accessible
-
Emits an XML document representing all of the properties contained in this table.
- SYNC - Enum constant in enum org.aeonbits.owner.Config.HotReloadType
-
The hot reload will happen when one of the methods is invoked on the
Configclass. - system() - Static method in class org.aeonbits.owner.util.Util
-
Returns the configured
Util.SystemProvider. - SystemLoader - Class in org.aeonbits.owner.loaders
-
Allows specifying
system:propertiesandsystem:envwith the@Sourcesannotation. - SystemLoader() - Constructor for class org.aeonbits.owner.loaders.SystemLoader
-
A loader is built with no arguments, both when it is registered by hand and when
ServiceLoaderfinds it on the class path.
T
- TEBIBYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The IEC tebibyte.
- TemplateTool - Class in org.aeonbits.owner
-
Writes the properties file of a mapping interface, from the command line, without running the application it belongs to.
- TERABYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The SI terabyte.
- The construction is hybrid, because RSA cannot encrypt a value - Search tag in class org.aeonbits.owner.handlers.RsaHandler
- Section
- The marker - Search tag in interface org.aeonbits.owner.handlers.ValueHandler
- Section
- The token - Search tag in class org.aeonbits.owner.handlers.AesGcmHandler
- Section
- Tokenizer - Interface in org.aeonbits.owner
-
Tokenizer interface that specifies how to split a single value into tokens to be used as elements for arrays and collections.
- tokens(String) - Method in interface org.aeonbits.owner.Tokenizer
-
Splits the given string, into tokens that identify single elements.
- TomlLoader - Class in org.aeonbits.owner.formats.toml
- TomlLoader() - Constructor for class org.aeonbits.owner.formats.toml.TomlLoader
-
A loader is built with no arguments, both when it is registered by hand and when
ServiceLoaderfinds it on the class path. - toString() - Method in class org.aeonbits.owner.extras.jndi.JndiHandler
- toString() - Method in class org.aeonbits.owner.handlers.AesGcmHandler
-
Never the passphrase, which is the whole reason this is written rather than inherited.
- toString() - Method in class org.aeonbits.owner.handlers.RsaHandler
-
Never key material.
- toString() - Method in class org.aeonbits.owner.loaders.EnvDialect
- toString() - Method in class org.aeonbits.owner.loaders.IniDialect
- toString() - Method in class org.aeonbits.owner.loaders.SourceOptions.Option
- toString() - Method in class org.aeonbits.owner.Origin
-
Meant to be read by a person: the source when there is one, and what kind of place it was otherwise.
- toString() - Method in class org.aeonbits.owner.util.bytesize.ByteSize
- toString() - Method in class org.aeonbits.owner.validation.ConstrainedProperty
-
A description for a log line: the key and the method, and never the value.
- toString() - Method in class org.aeonbits.owner.validation.Violation
-
The violation as it appears in the exception message: the key first, since that is what has to be changed, then the method it is declared on, then what is wrong with it.
- toStringLongForm() - Method in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
Returns the long string representation of this unit, such as "kilobytes", "megabytes" or "bytes".
- toStringShortForm() - Method in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
Returns the short string representation of this unit, such as "KiB", "B" or "MB".
- Traceable - Interface in org.aeonbits.owner
-
Allows a
Configobject to say where each of its properties came from. - TransactionalPropertyChangeListener - Interface in org.aeonbits.owner.event
-
A Listener that is aware of properties changes, with transactional capability.
- TransactionalReloadListener - Interface in org.aeonbits.owner.event
-
A Listener that is aware of properties reloads, with transactional capability.
- TRUE - Enum constant in enum org.aeonbits.owner.loaders.IniDialect.BareKeys
-
Read it as
true, which is what git config means by it. - Two things to know about the values - Search tag in class org.aeonbits.owner.extras.loaders.HoconLoader
- Section
- type() - Element in annotation type org.aeonbits.owner.Config.HotReload
-
The type of HotReload to use.
- Types are not guessed - Search tag in class org.aeonbits.owner.formats.yaml.YamlLoader
- Section
U
- unit() - Element in annotation type org.aeonbits.owner.Config.HotReload
-
The time unit for the interval.
- unreachableButCompilerNeedsThis() - Static method in class org.aeonbits.owner.util.Util
-
Always throws an
AssertionError; used to satisfy the compiler on branches that can never be reached. - unsupported(String, Object...) - Static method in class org.aeonbits.owner.util.Util
-
Builds an
UnsupportedOperationExceptionwith a formatted message. - unsupported(Throwable, String, Object...) - Static method in class org.aeonbits.owner.util.Util
-
Builds an
UnsupportedOperationExceptionwith a formatted message and a cause. - useOnEmpty() - Element in annotation type org.aeonbits.owner.Config.DefaultValue
-
Whether a property that is found but empty is to be treated as if it were missing, and the default used in its place.
- Util - Class in org.aeonbits.owner.util
-
This class contains utility methods used all over the library.
- Util.SystemProvider - Interface in org.aeonbits.owner.util
-
Abstraction over system properties and environment access, to allow overriding it in tests.
- Util.TimeProvider - Interface in org.aeonbits.owner.util
-
Abstraction over the source of the current time, to allow overriding it in tests.
V
- validate(List<ConstrainedProperty>) - Method in class org.aeonbits.owner.extras.validation.BeanValidator
-
Checks the given properties against the constraints their methods declare, with whichever of the two validation namespaces is present and has a provider — both, when both are.
- validate(List<ConstrainedProperty>) - Method in interface org.aeonbits.owner.validation.ConfigValidator
-
Checks the given properties against the constraints their methods declare.
- VALIDATION - Enum constant in enum org.aeonbits.owner.Config.DisableableFeature
-
Disables the checking of the Bean Validation constraints -
@Min,@NotNulland the rest - written on the annotated method, or on every method of the annotated interface. - value() - Element in annotation type org.aeonbits.owner.Config.CollectionConverterClass
-
The converter used to convert the property value to the collection returned by the method.
- value() - Element in annotation type org.aeonbits.owner.Config.ConverterClass
-
The converter used to convert the property value to the method return type.
- value() - Element in annotation type org.aeonbits.owner.Config.DeclaredOnly
-
Whether the restriction applies,
trueby default. - value() - Element in annotation type org.aeonbits.owner.Config.DecryptorClass
-
The default decryptor shared by all encrypted keys of the class.
- value() - Element in annotation type org.aeonbits.owner.Config.DefaultValue
-
The default value to be used when no property is found.
- value() - Element in annotation type org.aeonbits.owner.Config.Description
-
The sentence to write above the key.
- value() - Element in annotation type org.aeonbits.owner.Config.DisableFeature
-
The features to disable.
- value() - Element in annotation type org.aeonbits.owner.Config.EncryptedValue
-
The decryptor to use for this value.
- value() - Element in annotation type org.aeonbits.owner.Config.HotReload
-
The interval, expressed in seconds (by default), to perform checks on the filesystem to identify modified files and eventually perform the reloading of the properties.
- value() - Element in annotation type org.aeonbits.owner.Config.Key
-
The key used to look up the property.
- value() - Element in annotation type org.aeonbits.owner.Config.LoadPolicy
-
The policy used to load the properties files.
- value() - Element in annotation type org.aeonbits.owner.Config.Prefix
-
The prefix prepended to the keys of the properties declared in the annotated interface.
- value() - Element in annotation type org.aeonbits.owner.Config.PreprocessorClasses
-
The preprocessors applied, in order, to the property value.
- value() - Element in annotation type org.aeonbits.owner.Config.Separator
-
The separator the value is split on.
- value() - Element in annotation type org.aeonbits.owner.Config.Sources
-
The source URIs from which to load the properties, in URI string format.
- value() - Element in annotation type org.aeonbits.owner.Config.TokenizerClass
-
The tokenizer used to split the property value into elements.
- value() - Method in class org.aeonbits.owner.validation.ConstrainedProperty
-
The value the method answered with, converted to the return type as any caller would receive it - an
Optionalincluded, since a validation provider knows how to look inside one. - ValueHandler - Interface in org.aeonbits.owner.handlers
-
Turns the payload of a
${$name::payload}marker into the value that replaces it. - valueOf(String) - Static method in enum org.aeonbits.owner.Config.DisableableFeature
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.aeonbits.owner.Config.HotReloadType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.aeonbits.owner.Config.LoadType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.aeonbits.owner.loaders.EnvDialect.BareNames
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.aeonbits.owner.loaders.IniDialect.BareKeys
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.aeonbits.owner.loaders.IniDialect.Continuation
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.aeonbits.owner.loaders.IniDialect.Duplicates
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.aeonbits.owner.loaders.IniDialect.KeyCase
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.aeonbits.owner.loaders.IniDialect.Quotes
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.aeonbits.owner.loaders.IniDialect.Separator
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.aeonbits.owner.Origin.Kind
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.aeonbits.owner.util.bytesize.ByteSizeStandard
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.aeonbits.owner.Config.DisableableFeature
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.aeonbits.owner.Config.HotReloadType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.aeonbits.owner.Config.LoadType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.aeonbits.owner.loaders.EnvDialect.BareNames
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.aeonbits.owner.loaders.IniDialect.BareKeys
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.aeonbits.owner.loaders.IniDialect.Continuation
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.aeonbits.owner.loaders.IniDialect.Duplicates
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.aeonbits.owner.loaders.IniDialect.KeyCase
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.aeonbits.owner.loaders.IniDialect.Quotes
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.aeonbits.owner.loaders.IniDialect.Separator
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.aeonbits.owner.Origin.Kind
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.aeonbits.owner.util.bytesize.ByteSizeStandard
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
Returns an array containing the constants of this enum type, in the order they are declared.
- Values are kept as written, with one exception that is a rule - Search tag in class org.aeonbits.owner.formats.toml.TomlLoader
- Section
- VARIABLE_EXPANSION - Enum constant in enum org.aeonbits.owner.Config.DisableableFeature
-
Disables variable expansion, i.e.
- Violation - Class in org.aeonbits.owner.validation
-
One constraint that a property value did not satisfy.
- Violation(String, String, String) - Constructor for class org.aeonbits.owner.validation.Violation
-
Builds a violation.
W
- What a handler must not do - Search tag in interface org.aeonbits.owner.handlers.ValueHandler
- Section
- What a loader that is not found looks like - Search tag in interface org.aeonbits.owner.loaders.Loader
- Section
- What an absent value produces - Search tag in class org.aeonbits.owner.formats.yaml.YamlLoader
- Section
- What is expected back - Search tag in interface org.aeonbits.owner.validation.ConfigValidator
- Section
- What it accepts - Search tag in class org.aeonbits.owner.extras.jndi.JndiLoader
- Section
- What it costs, and to whom - Search tag in class org.aeonbits.owner.extras.loaders.HoconLoader
- Section
- What it costs, and to whom - Search tag in class org.aeonbits.owner.extras.validation.BeanValidator
- Section
- What it is called with, and what it is not - Search tag in interface org.aeonbits.owner.validation.ConfigValidator
- Section
- What it is for, and why it is not a variation on the other one - Search tag in class org.aeonbits.owner.handlers.RsaHandler
- Section
- What it needs - Search tag in class org.aeonbits.owner.extras.jndi.JndiLoader
- Section
- What it reads - Search tag in class org.aeonbits.owner.extras.jndi.JndiLoader
- Section
- What the construction is for - Search tag in class org.aeonbits.owner.handlers.AesGcmHandler
- Section
- What was wrong - Search tag in class org.aeonbits.owner.extras.validation.BeanValidator
- Section
- Where a loader sits among the others - Search tag in interface org.aeonbits.owner.loaders.Loader
- Section
- Which class loader does the looking - Search tag in interface org.aeonbits.owner.loaders.Loader
- Section
- Which of these methods expand the variables - Search tag in interface org.aeonbits.owner.Accessible
- Section
- Why this is Serializable, and the one trap in it - Search tag in interface org.aeonbits.owner.handlers.ValueHandler
- Section
- Why this one is not written by hand - Search tag in class org.aeonbits.owner.extras.loaders.HoconLoader
- Section
- withBareKeys(IniDialect.BareKeys) - Method in class org.aeonbits.owner.loaders.IniDialect
-
What a name with no separator after it means.
- withBareNames(EnvDialect.BareNames) - Method in class org.aeonbits.owner.loaders.EnvDialect
-
What to make of a line that names a variable without assigning to it.
- withContinuation(IniDialect.Continuation) - Method in class org.aeonbits.owner.loaders.IniDialect
-
How a value may run onto the line after it.
- withDefaultSectionInherited(boolean) - Method in class org.aeonbits.owner.loaders.IniDialect
-
Whether a section named
DEFAULTsupplies values to every other section, as Python's does, rather than being an ordinary section of that name. - withDuplicates(IniDialect.Duplicates) - Method in class org.aeonbits.owner.loaders.IniDialect
-
What a key repeated inside one section means.
- withEscapesExpanded(boolean) - Method in class org.aeonbits.owner.loaders.EnvDialect
-
Whether
\n,\tand their like are expanded inside a double-quoted value. - withExportPrefixStripped(boolean) - Method in class org.aeonbits.owner.loaders.EnvDialect
-
Whether a leading
exportis dropped, so that the file can also be sourced by a shell. - withInlineComments(boolean) - Method in class org.aeonbits.owner.loaders.EnvDialect
-
Whether a
#preceded by whitespace and outside quotes starts a comment that runs to the end of the line. - withInlineComments(boolean) - Method in class org.aeonbits.owner.loaders.IniDialect
-
Whether a
#or;after a value starts a comment. - withInterpolationRefused(boolean) - Method in class org.aeonbits.owner.loaders.IniDialect
-
Whether a value containing
%(name)sis refused. - withKeyCase(IniDialect.KeyCase) - Method in class org.aeonbits.owner.loaders.IniDialect
-
Whether a key is folded to lower case.
- withLineContinuation(boolean) - Method in class org.aeonbits.owner.loaders.EnvDialect
-
Whether a line ending in a backslash is joined to the one after it, as an
EnvironmentFileread by systemd allows. - withMultilineValues(boolean) - Method in class org.aeonbits.owner.loaders.EnvDialect
-
Whether a quoted value may run past the end of its line, up to the closing quote.
- withQuotes(IniDialect.Quotes) - Method in class org.aeonbits.owner.loaders.IniDialect
-
Whether matching quotes around a value delimit it, with escapes expanded inside them.
- withQuotesStripped(boolean) - Method in class org.aeonbits.owner.loaders.EnvDialect
-
Whether a value wrapped in matching quotes has them removed, rather than keeping them as part of it.
- withSeparator(IniDialect.Separator) - Method in class org.aeonbits.owner.loaders.IniDialect
-
Whether
:separates a key from its value as well as=. - withSubsections(boolean) - Method in class org.aeonbits.owner.loaders.IniDialect
-
Whether a quoted name in a section header is a subsection, so that
[remote "origin"]isremote.origin.
X
- XMLLoader - Class in org.aeonbits.owner.loaders
-
A
loaderable to read properties from standard XML Java properties files, as well as user defined XML properties files. - XMLLoader() - Constructor for class org.aeonbits.owner.loaders.XMLLoader
-
A loader is built with no arguments, both when it is registered by hand and when
ServiceLoaderfinds it on the class path.
Y
- YamlLoader - Class in org.aeonbits.owner.formats.yaml
- YamlLoader() - Constructor for class org.aeonbits.owner.formats.yaml.YamlLoader
-
A loader is built with no arguments, both when it is registered by hand and when
ServiceLoaderfinds it on the class path. - YOBIBYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The IEC yobibyte.
- YOTTABYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The SI yottabyte.
Z
- ZEBIBYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The IEC zebibyte.
- ZETTABYTES - Enum constant in enum org.aeonbits.owner.util.bytesize.ByteSizeUnit
-
The SI zettabyte.
- ZooKeeperLoader - Class in org.aeonbits.owner.extras.loaders
-
A
loaderthat reads the properties from the children of a ZooKeeper node, addressed with thezookeeperscheme: - ZooKeeperLoader() - Constructor for class org.aeonbits.owner.extras.loaders.ZooKeeperLoader
-
A loader is built with no arguments, both when it is registered by hand and when
ServiceLoaderfinds it on the class path.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form