A C D E G H I K L M P R S T

A

addListener(Consumer<Element>) - Method in interface com.xpcagey.config.api.Config

Places a change listener into the system.

addTrigger(String, Consumer<Element>) - Method in interface com.xpcagey.config.api.Config

Places a listener for a single key into the system.

C

CircularRequirementsException - Exception in com.xpcagey.config.api

CircularRequirementsException(Collection<Descriptor>) - Constructor for exception com.xpcagey.config.api.CircularRequirementsException

com.xpcagey.config.api - package com.xpcagey.config.api

compareTo(Descriptor) - Method in class com.xpcagey.config.api.Descriptor

Config - Interface in com.xpcagey.config.api

ConfigEngine - Interface in com.xpcagey.config.api

ConfigLoadException - Exception in com.xpcagey.config.api

ConfigLoadException is a common ancestor for loader exceptions that is provided for convenience

configName - Variable in exception com.xpcagey.config.api.MissingElementException

ConfigSystem - Class in com.xpcagey.config.api

D

desc - Variable in exception com.xpcagey.config.api.CircularRequirementsException

desc - Variable in exception com.xpcagey.config.api.MissingConfigException

Descriptor - Class in com.xpcagey.config.api

Descriptor(String, String, boolean) - Constructor for class com.xpcagey.config.api.Descriptor

E

Element - Interface in com.xpcagey.config.api

Each Element is a single value inside of configuration.

equals(Object) - Method in class com.xpcagey.config.api.Descriptor

G

get(String) - Method in interface com.xpcagey.config.api.Config

Attempt to retrieve an element by key in a type safe manner that allows functional chaining; best used when a key is not required and the program needs to branch based on its presence

getAlias() - Method in class com.xpcagey.config.api.Descriptor

getAll() - Method in interface com.xpcagey.config.api.Config

Returns a snapshot of the current elements inside this configuration; if there were multiple descriptors used to build a compound configuration the map will be flattened to show only the values that would be returned by get queries.

getAsDuration() - Method in interface com.xpcagey.config.api.Element

getAsInstant() - Method in interface com.xpcagey.config.api.Element

getAsString() - Method in interface com.xpcagey.config.api.Element

getKey() - Method in interface com.xpcagey.config.api.Element

The key for this element relative to the root of its configuration

getName() - Method in interface com.xpcagey.config.api.Config

Returns the name of this configuration; useful if a program wants to have distinct configuration blocks that each correspond to a different context.

getOrNull(String) - Method in interface com.xpcagey.config.api.Config

Attempt to retrieve an element by key efficiently by not wrapping for type safety if it is missing; best used in situations where temporary object creation overhead is not acceptable but the value is not required

getOrThrow(String) - Method in interface com.xpcagey.config.api.Config

Attempt to retrieve an element by key without needing conditional logic to interpret the result; best used when a default has been set for the key or when the program must have a value to operate correctly.

getProvider() - Method in class com.xpcagey.config.api.Descriptor

getRawPath() - Method in class com.xpcagey.config.api.Descriptor

getRawPath() - Method in class com.xpcagey.config.api.KeyedDescriptor

getRawPath() - Method in class com.xpcagey.config.api.PathDescriptor

getResolverInputs() - Method in class com.xpcagey.config.api.Descriptor

getResolverInputs() - Method in class com.xpcagey.config.api.KeyedDescriptor

getResolverInputs() - Method in class com.xpcagey.config.api.PathDescriptor

getSources() - Method in interface com.xpcagey.config.api.Config

Lists the items that were used to construct this configuration; useful for debugging

H

hasEqualValue(Element) - Method in interface com.xpcagey.config.api.Element

hashCode() - Method in class com.xpcagey.config.api.Descriptor

hasKey(String) - Method in interface com.xpcagey.config.api.Config

Queries the configuration to see if it currently has an element at the specified key

I

IllegalPathException - Exception in com.xpcagey.config.api

IllegalPathException should be thrown by a ConfigEngine if a requested path is malformed or unreachable.

IllegalPathException(String, String, String, Throwable) - Constructor for exception com.xpcagey.config.api.IllegalPathException

isRequired() - Method in class com.xpcagey.config.api.Descriptor

isSensitive() - Method in interface com.xpcagey.config.api.Element

If an element is sensitive it should not be logged or stored without encryption

K

key - Variable in exception com.xpcagey.config.api.MissingElementException

KeyedDescriptor - Class in com.xpcagey.config.api

KeyedDescriptor(String, String, String, boolean, String...) - Constructor for class com.xpcagey.config.api.KeyedDescriptor

L

load(String, ClassLoader, Executor, Descriptor...) - Method in interface com.xpcagey.config.api.ConfigEngine

load(String, Executor, Descriptor...) - Static method in class com.xpcagey.config.api.ConfigSystem

load(String, ClassLoader, Executor, Descriptor...) - Static method in class com.xpcagey.config.api.ConfigSystem

M

MissingConfigException - Exception in com.xpcagey.config.api

MissingConfigException(Descriptor) - Constructor for exception com.xpcagey.config.api.MissingConfigException

MissingElementException - Exception in com.xpcagey.config.api

MissingElementException(String, String) - Constructor for exception com.xpcagey.config.api.MissingElementException

MissingLoaderException - Exception in com.xpcagey.config.api

MissingLoaderException(String) - Constructor for exception com.xpcagey.config.api.MissingLoaderException

MissingResolverFieldException - Exception in com.xpcagey.config.api

MissingResolverFieldException(MissingElementException) - Constructor for exception com.xpcagey.config.api.MissingResolverFieldException

P

path - Variable in exception com.xpcagey.config.api.IllegalPathException

PathDescriptor - Class in com.xpcagey.config.api

PathDescriptor(String, String, String, boolean) - Constructor for class com.xpcagey.config.api.PathDescriptor

provider - Variable in exception com.xpcagey.config.api.IllegalPathException

provider - Variable in exception com.xpcagey.config.api.MissingLoaderException

R

rawPath - Variable in exception com.xpcagey.config.api.IllegalPathException

removeListener(Consumer<Element>) - Method in interface com.xpcagey.config.api.Config

Removes a change listener from the system.

removeTrigger(String, Consumer<Element>) - Method in interface com.xpcagey.config.api.Config

Removes a listener for a single key from the system.

resolve(Config) - Method in class com.xpcagey.config.api.Descriptor

resolve(Config) - Method in class com.xpcagey.config.api.KeyedDescriptor

resolve(Config) - Method in class com.xpcagey.config.api.PathDescriptor

S

setDefault(String, boolean) - Method in interface com.xpcagey.config.api.ConfigEngine

setDefault(String, double) - Method in interface com.xpcagey.config.api.ConfigEngine

setDefault(String, Duration) - Method in interface com.xpcagey.config.api.ConfigEngine

setDefault(String, Instant) - Method in interface com.xpcagey.config.api.ConfigEngine

setDefault(String, long) - Method in interface com.xpcagey.config.api.ConfigEngine

setDefault(String, String) - Method in interface com.xpcagey.config.api.ConfigEngine

setDefault(String, boolean) - Static method in class com.xpcagey.config.api.ConfigSystem

setDefault(String, double) - Static method in class com.xpcagey.config.api.ConfigSystem

setDefault(String, Duration) - Static method in class com.xpcagey.config.api.ConfigSystem

setDefault(String, Instant) - Static method in class com.xpcagey.config.api.ConfigSystem

setDefault(String, long) - Static method in class com.xpcagey.config.api.ConfigSystem

setDefault(String, String) - Static method in class com.xpcagey.config.api.ConfigSystem

subtree(String) - Method in interface com.xpcagey.config.api.Config

Creates an artificial mapping of elements that start with the input path segment prefix; skips the prefix when reporting names inside of the subtree.

T

toString() - Method in class com.xpcagey.config.api.Descriptor

A C D E G H I K L M P R S T