Index
All Classes and Interfaces|All Packages|Serialized Form
A
- ABOVE - Enum constant in enum space.arim.dazzleconf.engine.CommentLocation
-
Above the entry
- Abstract() - Constructor for class space.arim.dazzleconf.backend.Printable.Abstract
-
Creates
- add(DataEntry) - Method in class space.arim.dazzleconf.backend.DataList.Mut
-
Adds the given entry, expanding this list to accommodate
- addBack(CharSequence) - Method in class space.arim.dazzleconf.backend.KeyPath.Mut
-
Adds a key part at the back.
- addDefaultTypeLiaisons() - Method in class space.arim.dazzleconf.ConfigurationBuilder
-
Adds the default type liaisons to this builder.
- addDetail(ErrorContext.Key<V>, V) - Method in interface space.arim.dazzleconf.ErrorContext
-
Adds a piece of detail to this error context, overriding previous values.
- addFilter(MigrateSource.Filter<C>) - Method in class space.arim.dazzleconf.migration.MigrateFromConfiguration
- addFilter(MigrateSource.Filter<C>) - Method in interface space.arim.dazzleconf.migration.MigrateSource
-
Returns a new migration source, with the given filter applied.
- addFront(CharSequence) - Method in class space.arim.dazzleconf.backend.KeyPath.Mut
-
Adds a key part at the front.
- addMigration(Migration<?, C>) - Method in class space.arim.dazzleconf.ConfigurationBuilder
-
Adds the following migration to this builder.
- addMigrations(List<Migration<?, C>>) - Method in class space.arim.dazzleconf.ConfigurationBuilder
-
Adds the following migrations to this builder.
- addPath(KeyPath.SequenceBoundary, KeyPath) - Method in class space.arim.dazzleconf.backend.KeyPath.Mut
-
Adds another key path to this one, either at the front or back of this key path.
- addPrimitiveTypeLiaisons() - Method in class space.arim.dazzleconf.ConfigurationBuilder
-
Adds type liaisons for primitives and
Stringto this builder. - addSimpleSerializer(TypeToken<V>, SerializeDeserialize<V>) - Method in class space.arim.dazzleconf.ConfigurationBuilder
-
Adds a simple type liaison based on a single serializer.
- addTypeLiaisons(List<TypeLiaison>) - Method in class space.arim.dazzleconf.ConfigurationBuilder
-
Adds the following type liaisons to this builder.
- addTypeLiaisons(TypeLiaison...) - Method in class space.arim.dazzleconf.ConfigurationBuilder
-
Adds the following type liaisons to this builder.
- allKeys() - Method in interface space.arim.dazzleconf.ErrorContext
-
Gets all the keys set on this error context.
- allKeysAreStrings() - Method in interface space.arim.dazzleconf.backend.Backend.Meta
-
Whether the backend only recognizes string keys.
- Annotated(Class<?>, ReifiedType.Annotated[], AnnotatedElement) - Constructor for class space.arim.dazzleconf.reflect.ReifiedType.Annotated
-
Creates from nonnull input arguments
- append(CommentData) - Method in class space.arim.dazzleconf.backend.CommentData
-
Appends another set of comments to this one.
- appendAt(CommentLocation, String...) - Method in class space.arim.dazzleconf.backend.CommentData
-
Appends comments at the following location and returns a new object.
- appendAt(CommentLocation, List<String>) - Method in class space.arim.dazzleconf.backend.CommentData
-
Appends comments at the following location and returns a new object.
- applyKeyMapper(KeyMapper) - Method in class space.arim.dazzleconf.backend.KeyPath.Mut
-
Applies a key mapper to existing key parts.
- argumentAt(int) - Method in class space.arim.dazzleconf.reflect.ReifiedType.Annotated
-
Gets the argument at a certain index
- argumentAt(int) - Method in class space.arim.dazzleconf.reflect.ReifiedType
-
Gets the argument at a certain index
- argumentCount() - Method in class space.arim.dazzleconf.reflect.ReifiedType
-
The argument count
- arguments() - Method in class space.arim.dazzleconf.reflect.ReifiedType.Annotated
-
Gets all the arguments
- arguments() - Method in class space.arim.dazzleconf.reflect.ReifiedType
-
Gets all the arguments
B
- BACK - Enum constant in enum space.arim.dazzleconf.backend.KeyPath.SequenceBoundary
- Backend - Interface in space.arim.dazzleconf.backend
-
Configuration backend for reading and writing data trees.
- BACKEND_MESSAGE - Static variable in interface space.arim.dazzleconf.ErrorContext
-
Error message provided by the configuration format backend
- Backend.Document - Interface in space.arim.dazzleconf.backend
-
A document loaded from, or writable to, a backend.
- Backend.Meta - Interface in space.arim.dazzleconf.backend
-
Defines metadata about a backend.
- BELOW - Enum constant in enum space.arim.dazzleconf.engine.CommentLocation
-
Below the entry
- BinaryRoot - Interface in space.arim.dazzleconf.backend
-
Data roots which are capable of working with raw bytes.
- BooleanDefault - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Specifies the default value as a boolean.
- BooleanLiaison - Class in space.arim.dazzleconf.engine.liaison
-
Liaison for booleans
- BooleanLiaison() - Constructor for class space.arim.dazzleconf.engine.liaison.BooleanLiaison
-
Creates
- build() - Method in class space.arim.dazzleconf.ConfigurationBuilder
-
Builds into a fully fledged configuration.
- buildError(Printable) - Method in interface space.arim.dazzleconf.ErrorContext.Source
-
Builds an error context based on the implementation.
- buildFrom(Comments[]) - Static method in class space.arim.dazzleconf.backend.CommentData
-
Makes an instance of this class according to
Commentsannotations. - ByteDefault - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Specifies the default value as a byte.
- ByteLiaison - Class in space.arim.dazzleconf.engine.liaison
-
Liaison for bytes
- ByteLiaison() - Constructor for class space.arim.dazzleconf.engine.liaison.ByteLiaison
-
Creates
- ByteRange - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Controls the range of a byte.
C
- CallableFn - Annotation Type in space.arim.dazzleconf.engine
-
Denotes a callable default method in a configuration interface.
- callDefaultImpl(MethodId) - Method in class space.arim.dazzleconf.reflect.MethodYield.ForImplementable
-
Specifies to invoke the default implementation.
- cast(Object) - Method in class space.arim.dazzleconf.reflect.TypeToken
-
Casts the argument to this type.
- chain(Transition<C_NEW, C_NEWER>) - Method in interface space.arim.dazzleconf.migration.Transition
-
Chains on another transition after this one
- CharacterLiaison - Class in space.arim.dazzleconf.engine.liaison
-
Liaison for
charandCharacter. - CharacterLiaison() - Constructor for class space.arim.dazzleconf.engine.liaison.CharacterLiaison
-
Creates
- clear() - Method in class space.arim.dazzleconf.backend.DataList.Mut
-
Clears all data
- clear() - Method in class space.arim.dazzleconf.backend.DataTree.Mut
-
Clears all data
- clear() - Method in class space.arim.dazzleconf.reflect.MethodYield
-
Clears all added values and starts over again
- clearAt(CommentLocation...) - Method in class space.arim.dazzleconf.backend.CommentData
-
Clears comments at some locations and returns a new object
- clearDetail(ErrorContext.Key<?>) - Method in interface space.arim.dazzleconf.ErrorContext
-
Clears the specified context for this error context
- clearLineNumber() - Method in class space.arim.dazzleconf.backend.DataEntry
-
Clears the line number and returns a new object
- clearTypeLiaisons() - Method in class space.arim.dazzleconf.ConfigurationBuilder
-
Clears the type liaisons currently set on this builder
- close() - Method in class space.arim.dazzleconf.reflect.MethodYield.ForImplementable
- CollectionLiaison - Class in space.arim.dazzleconf.engine.liaison
-
Liaison for lists, sets, and collections.
- CollectionLiaison() - Constructor for class space.arim.dazzleconf.engine.liaison.CollectionLiaison
-
Creates the liaison
- CommentData - Class in space.arim.dazzleconf.backend
-
The comments on a data entry or configuration class.
- CommentLocation - Enum in space.arim.dazzleconf.engine
-
Where comments are located
- comments() - Method in interface space.arim.dazzleconf.backend.Backend.Document
-
The document-level comments.
- Comments - Annotation Type in space.arim.dazzleconf.engine
-
Adds comments to a configuration entry or type.
- Comments.Container - Annotation Type in space.arim.dazzleconf.engine
-
The repeatable annotations container for adding multiple comments.
- Configuration<C> - Interface in space.arim.dazzleconf
-
Main interface.
- ConfigurationBuilder<C> - Class in space.arim.dazzleconf
-
A builder for
Configuration. - ConfigurationBuilder(TypeToken<C>) - Constructor for class space.arim.dazzleconf.ConfigurationBuilder
-
Creates for the specified interface type.
- ConfigurationDefinition<C> - Interface in space.arim.dazzleconf
-
Provides the minimal methods for reading and writing configurations from data trees
- ConfigurationDefinition.Layout - Interface in space.arim.dazzleconf
-
The layout of a configuration definition.
- ConfigurationDefinition.ReadOptions - Interface in space.arim.dazzleconf
-
Parameters for reading a configuration from a tree
- ConfigurationDefinition.ReadWithUpdateOptions - Interface in space.arim.dazzleconf
-
Parameters for reading a configuration and updating it in-place
- ConfigurationDefinition.WriteOptions - Interface in space.arim.dazzleconf
-
Parameters for writing a configuration to a tree
- ConfigureListener - Interface in space.arim.dazzleconf
-
Listener that lets the implementor know about various configuration events
- configureOrFallback(Backend, ConfigureListener, ErrorPrint) - Method in interface space.arim.dazzleconf.Configuration
-
Configures, migrates, and/or updates the backend as needed.
- configureOrFallback(Backend, ErrorPrint) - Method in interface space.arim.dazzleconf.Configuration
-
Configures, migrates, and/or updates the backend as needed.
- configureWith(Backend) - Method in interface space.arim.dazzleconf.Configuration
-
Configures, migrates, and/or updates the backend as needed.
- configureWith(Backend, ConfigureListener) - Method in interface space.arim.dazzleconf.Configuration
-
Configures, migrates, and/or updates the backend as needed.
- copy() - Method in class space.arim.dazzleconf.reflect.MethodYield
-
Returns a deep copy of this method yield's contents.
- copyDetailsInto(ErrorContext) - Method in interface space.arim.dazzleconf.ErrorContext
-
Copies all context details from this error context into another one
- copyFrom(DataTree) - Method in class space.arim.dazzleconf.backend.DataTree.Mut
-
Merges all data in the specified data tree into this one, merging nested sections.
D
- data() - Method in interface space.arim.dazzleconf.backend.Backend.Document
-
The data itself, in the form of a navigable tree
- DataEntry - Class in space.arim.dazzleconf.backend
-
A data value, with associated metadata as interoperable with backend formats.
- DataEntry(Object) - Constructor for class space.arim.dazzleconf.backend.DataEntry
-
Creates from a nonnull value.
- dataExists() - Method in interface space.arim.dazzleconf.backend.DataRoot
-
Checks whether the data is known to exist.
- dataExists() - Method in class space.arim.dazzleconf.backend.PathRoot
- dataExists() - Method in class space.arim.dazzleconf.backend.StringRoot
- DataList - Class in space.arim.dazzleconf.backend
-
A list of in-memory configuration data.
- DataList() - Constructor for class space.arim.dazzleconf.backend.DataList
- DataList.Immut - Class in space.arim.dazzleconf.backend
-
A data list which is immutable.
- DataList.Mut - Class in space.arim.dazzleconf.backend
-
A data list which can be modified.
- DataRoot - Interface in space.arim.dazzleconf.backend
-
The root source of configuration data.
- DataRoot.Operation<R,
U> - Interface in space.arim.dazzleconf.backend -
IO proof, functional interface for use with reader/writer methods
- DataTree - Class in space.arim.dazzleconf.backend
-
A tree of in-memory configuration data.
- DataTree.Immut - Class in space.arim.dazzleconf.backend
-
A data tree which is immutable.
- DataTree.Mut - Class in space.arim.dazzleconf.backend
-
A data tree which can be modified.
- defaultBuilder(Class<C>) - Static method in interface space.arim.dazzleconf.Configuration
-
Convenience method for building a configuration.
- defaultBuilder(TypeToken<C>) - Static method in interface space.arim.dazzleconf.Configuration
-
Convenience method for building a configuration that adds the default type liaisons.
- DefaultKeyMapper - Class in space.arim.dazzleconf.backend
-
Default, "no-op" mapper for keys and method names
- DefaultKeyMapper() - Constructor for class space.arim.dazzleconf.backend.DefaultKeyMapper
-
Creates
- DefaultReflectionService - Class in space.arim.dazzleconf.reflect
-
The default implementation of
ReflectionService. - DefaultReflectionService() - Constructor for class space.arim.dazzleconf.reflect.DefaultReflectionService
-
Creates the service
- defaultValue() - Method in interface space.arim.dazzleconf.engine.DefaultValues
-
Gets the default value
- DefaultValues<V> - Interface in space.arim.dazzleconf.engine
-
Storage for default values
- deserialize(DeserializeInput) - Method in interface space.arim.dazzleconf.engine.SerializeDeserialize
-
Deserializes using the given operable object.
- DeserializeContext - Interface in space.arim.dazzleconf.engine
-
A context for deserialization.
- DeserializeInput - Interface in space.arim.dazzleconf.engine
-
An object from a data tree, that is being processed for deserialization.
- deserializeUpdate(DeserializeInput, SerializeOutput) - Method in interface space.arim.dazzleconf.engine.SerializeDeserialize
-
Deserializes using the given operable object, and updates the input value if needed.
- DeveloperMistakeException - Exception Class in space.arim.dazzleconf
-
Thrown whenever a preventable problem in how the configuration was constructed or defined arises at runtime.
- DeveloperMistakeException(String) - Constructor for exception class space.arim.dazzleconf.DeveloperMistakeException
-
Creates from the given message
- DeveloperMistakeException(String, Throwable) - Constructor for exception class space.arim.dazzleconf.DeveloperMistakeException
-
Creates from a message and cause
- display() - Method in interface space.arim.dazzleconf.ErrorContext
-
Formats this error context and includes all information.
- DoubleDefault - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Specifies the default value as a double
- DoubleLiaison - Class in space.arim.dazzleconf.engine.liaison
-
Liaison for doubles
- DoubleLiaison() - Constructor for class space.arim.dazzleconf.engine.liaison.DoubleLiaison
-
Creates
- DoubleRange - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Controls the range of a double.
E
- empty() - Static method in class space.arim.dazzleconf.backend.CommentData
-
Returns an empty instance of
Comments - empty() - Static method in class space.arim.dazzleconf.backend.KeyPath
-
Returns an empty key path.
- EMPTY_ARRAY - Static variable in class space.arim.dazzleconf.reflect.ReifiedType.Annotated
-
A reusable empty array for this type
- enclosingType() - Method in interface space.arim.dazzleconf.engine.TypeLiaison.DefaultInit
-
The interface type where the method is located, after computing inheritance.
- entries() - Method in class space.arim.dazzleconf.reflect.MethodYield
-
Gets all entries added.
- entry() - Method in interface space.arim.dazzleconf.engine.DeserializeInput
-
The entry of the object being deserialized.
- ENTRY_PATH - Static variable in interface space.arim.dazzleconf.ErrorContext
-
Path of the configuration entry being scanned or operated upon
- EnumLiaison - Class in space.arim.dazzleconf.engine.liaison
-
A liaison for enum types.
- EnumLiaison() - Constructor for class space.arim.dazzleconf.engine.liaison.EnumLiaison
-
Creates
- equals(Object) - Method in class space.arim.dazzleconf.backend.CommentData
- equals(Object) - Method in class space.arim.dazzleconf.backend.DataEntry
- equals(Object) - Method in class space.arim.dazzleconf.backend.DataList
- equals(Object) - Method in class space.arim.dazzleconf.backend.DataTree
- equals(Object) - Method in class space.arim.dazzleconf.backend.KeyPath
- equals(Object) - Method in class space.arim.dazzleconf.LoadResult
- equals(Object) - Method in class space.arim.dazzleconf.reflect.InvokeDefaultFunction
- equals(Object) - Method in class space.arim.dazzleconf.reflect.MethodId
- equals(Object) - Method in class space.arim.dazzleconf.reflect.MethodYield
- equals(Object) - Method in class space.arim.dazzleconf.reflect.ReifiedType
- equals(Object) - Method in class space.arim.dazzleconf.reflect.TypeToken
-
A type token is equal to another when it points to the same reified type (at runtime)
- ErrorContext - Interface in space.arim.dazzleconf
-
Context holder for errors in
LoadResult. - ErrorContext.Key<V> - Class in space.arim.dazzleconf
-
A marker for context keys
- ErrorContext.Source - Interface in space.arim.dazzleconf
-
A source of error contexts.
- ErrorPrint - Interface in space.arim.dazzleconf
-
Output device for when an error occured
- ErrorPrint.Output - Interface in space.arim.dazzleconf
-
The message sink (used by some
ErrorPrintimplementations) where printable messages are sent - errorSource() - Method in interface space.arim.dazzleconf.migration.MigrateContext
-
A factory allowing migrations to produce errors.
F
- failure(List<ErrorContext>) - Static method in class space.arim.dazzleconf.LoadResult
-
Creates a failed load result with the given error contexts
- failure(ErrorContext...) - Static method in class space.arim.dazzleconf.LoadResult
-
Creates a failed load result with the given error contexts
- flatMap(Function<? super R, ? extends LoadResult<R_NEW>>) - Method in class space.arim.dazzleconf.LoadResult
-
Maps from one load result to another.
- FloatDefault - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Specifies the default value as a float
- FloatLiaison - Class in space.arim.dazzleconf.engine.liaison
-
Liaison for floats
- FloatLiaison() - Constructor for class space.arim.dazzleconf.engine.liaison.FloatLiaison
-
Creates
- FloatRange - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Controls the range of a double.
- forEach(Consumer<? super CharSequence>) - Method in class space.arim.dazzleconf.backend.KeyPath
-
Runs an action for each key part in the sequence, starting from the front
- forEach(BiConsumer<? super Object, ? super DataEntry>) - Method in class space.arim.dazzleconf.backend.DataTree
-
Runs an action for each key/value pair.
- forEach(BiConsumer<? super Object, ? super DataEntry>) - Method in class space.arim.dazzleconf.backend.DataTree.Immut
- forEach(BiConsumer<? super Object, ? super DataEntry>) - Method in class space.arim.dazzleconf.backend.DataTree.Mut
- forEach(Consumer<? super DataEntry>) - Method in class space.arim.dazzleconf.backend.DataList
-
Runs an action for each element.
- forEach(Consumer<? super DataEntry>) - Method in class space.arim.dazzleconf.backend.DataList.Immut
- forEach(Consumer<? super DataEntry>) - Method in class space.arim.dazzleconf.backend.DataList.Mut
- forImplementable(Class<?>) - Method in class space.arim.dazzleconf.reflect.MethodYield
-
Begins adding yield values for the given interface.
- ForImplementable() - Constructor for class space.arim.dazzleconf.reflect.MethodYield.ForImplementable
- FRONT - Enum constant in enum space.arim.dazzleconf.backend.KeyPath.SequenceBoundary
G
- generate(Class<I>, MethodYield) - Method in interface space.arim.dazzleconf.reflect.Instantiator
-
Generates the target class.
- generateEmpty(Class<I>) - Method in interface space.arim.dazzleconf.reflect.Instantiator
-
Generates an "empty" implementation for the given interface type, which lets the caller use its default method implementations.
- generateShell(Class<I>) - Method in interface space.arim.dazzleconf.reflect.Instantiator
-
Makes a reloadable shell for the given interface type.
- get(int) - Method in class space.arim.dazzleconf.backend.DataList
-
Gets the entry at the specified index.
- get(int) - Method in class space.arim.dazzleconf.backend.DataList.Immut
- get(int) - Method in class space.arim.dazzleconf.backend.DataList.Mut
- get(Object) - Method in class space.arim.dazzleconf.backend.DataTree
-
Gets the entry at the specified key, or null if unset.
- get(Object) - Method in class space.arim.dazzleconf.backend.DataTree.Immut
- get(Object) - Method in class space.arim.dazzleconf.backend.DataTree.Mut
- getAndClearLastOutput() - Method in interface space.arim.dazzleconf.engine.SerializeOutput
-
Gets the last output, clears it in this
SerializeOutput, and returns it to the caller. - getAnnotation(Class<T>) - Method in class space.arim.dazzleconf.reflect.ReifiedType.Annotated
- getAnnotations() - Method in class space.arim.dazzleconf.reflect.ReifiedType.Annotated
- getAnnotations(MethodId) - Method in interface space.arim.dazzleconf.reflect.MethodMirror.TypeWalker
-
Gets annotations present on the specified method.
- getAnnotationsByType(Class<T>) - Method in class space.arim.dazzleconf.reflect.ReifiedType.Annotated
- getAt(CommentLocation) - Method in class space.arim.dazzleconf.backend.CommentData
-
Gets the comments at the specified location.
- getComments() - Method in class space.arim.dazzleconf.backend.DataEntry
-
Gets the comments present
- getComments() - Method in interface space.arim.dazzleconf.ConfigurationDefinition.Layout
-
Gets the top level comments on the configuration interface.
- getComments(CommentLocation) - Method in class space.arim.dazzleconf.backend.DataEntry
-
Gets the comments present on this entry at the specified location.
- getConfiguration(TypeToken<U>) - Method in interface space.arim.dazzleconf.engine.TypeLiaison.Handshake
-
Gets another configuration.
- getCurrentDelegate() - Method in interface space.arim.dazzleconf.ReloadShell
-
Gets the current inner delegate
- getDeclaredAnnotation(Class<T>) - Method in class space.arim.dazzleconf.reflect.ReifiedType.Annotated
- getDeclaredAnnotations() - Method in class space.arim.dazzleconf.reflect.ReifiedType.Annotated
- getDeclaredAnnotationsByType(Class<T>) - Method in class space.arim.dazzleconf.reflect.ReifiedType.Annotated
- getEnclosingType() - Method in interface space.arim.dazzleconf.reflect.MethodMirror.TypeWalker
-
Gets the type which this
TypeWalkeris looking at - getErrorContexts() - Method in class space.arim.dazzleconf.LoadResult
-
Gets the error contexts.
- getInstantiator() - Method in interface space.arim.dazzleconf.ConfigurationDefinition.Layout
-
Gets the instantiator used to generate interface implementations.
- getKeyMapper() - Method in interface space.arim.dazzleconf.Configuration
-
Gets the key mapper if one was specified during construction.
- getLayout() - Method in interface space.arim.dazzleconf.ConfigurationDefinition
-
Gets the layout of the configuration interface
- getLeading(KeyPath.SequenceBoundary) - Method in class space.arim.dazzleconf.backend.KeyPath
-
Regarding this key path as a sequence of strings, this function returns either the very first value (if using
SequenceBoundary.FRONT) or the very last value (ifSequenceBoundary.BACK). - getLineNumber() - Method in class space.arim.dazzleconf.backend.DataEntry
-
Gets the line number if present
- getLocale() - Method in interface space.arim.dazzleconf.Configuration
-
Gets the locale used at the library level.
- getLocale() - Method in interface space.arim.dazzleconf.ErrorContext
-
The locale to format messages in.
- getLocale() - Method in interface space.arim.dazzleconf.ErrorContext.Source
-
The locale to format error messages in.
- getMethodMirror() - Method in interface space.arim.dazzleconf.ConfigurationDefinition.Layout
-
Gets the method mirror used to invoke methods
- getMigrations() - Method in interface space.arim.dazzleconf.Configuration
-
Gets the migrations.
- getOpaqueCache() - Method in class space.arim.dazzleconf.reflect.MethodId
-
Gets the opaque cache attached to this method ID, if one exists.
- getOrThrow() - Method in class space.arim.dazzleconf.LoadResult
-
Unwraps the success value or throws an exception.
- getOtherSerializer(TypeToken<U>) - Method in interface space.arim.dazzleconf.engine.TypeLiaison.Handshake
-
Gets another serializer.
- getRawType() - Method in class space.arim.dazzleconf.reflect.TypeToken
-
Gets the raw type as a class object
- getReifiedType() - Method in interface space.arim.dazzleconf.ConfigurationDefinition.Layout
-
Gets the type of the configuration interface.
- getReifiedType() - Method in class space.arim.dazzleconf.reflect.TypeToken
-
Gets the annotated reified type represented by this type token
- getShell() - Method in interface space.arim.dazzleconf.ReloadShell
-
Gets the configuration shell, a proxy to the current delegate.
- getSuperTypes() - Method in interface space.arim.dazzleconf.reflect.MethodMirror.TypeWalker
-
Moves to the directly declared super types of this type
- getType() - Method in interface space.arim.dazzleconf.ConfigurationDefinition
-
Gets the reified type of the configuration interface
- getTypeLiaisons() - Method in interface space.arim.dazzleconf.Configuration
-
Gets all type liaisons.
- getValue() - Method in class space.arim.dazzleconf.backend.DataEntry
-
Gets the value.
- getValue() - Method in class space.arim.dazzleconf.LoadResult
-
Tries to get at the success value.
- getViableMethods() - Method in interface space.arim.dazzleconf.reflect.MethodMirror.TypeWalker
-
Gets all accessible, non-inherited, instance methods declared in this type.
H
- handlesBuffering() - Method in interface space.arim.dazzleconf.backend.DataRoot.Operation
-
Instructs the caller that this implementation handles its own buffering to the utility in
DataRoot.Operation.operateUsing(Object) - hashCode() - Method in class space.arim.dazzleconf.backend.CommentData
- hashCode() - Method in class space.arim.dazzleconf.backend.DataEntry
- hashCode() - Method in class space.arim.dazzleconf.backend.DataList
- hashCode() - Method in class space.arim.dazzleconf.backend.DataTree
- hashCode() - Method in class space.arim.dazzleconf.backend.KeyPath
- hashCode() - Method in class space.arim.dazzleconf.LoadResult
- hashCode() - Method in class space.arim.dazzleconf.reflect.InvokeDefaultFunction
- hashCode() - Method in class space.arim.dazzleconf.reflect.MethodId
- hashCode() - Method in class space.arim.dazzleconf.reflect.MethodYield
- hashCode() - Method in class space.arim.dazzleconf.reflect.ReifiedType
- hashCode() - Method in class space.arim.dazzleconf.reflect.TypeToken
- hasProduced(Object) - Method in interface space.arim.dazzleconf.reflect.Instantiator
-
Checks whether this instantiator produced the specified object.
I
- ifMissing() - Method in interface space.arim.dazzleconf.engine.DefaultValues
-
Gets the value if missing in an existing configuration
- ifMissing() - Element in annotation type space.arim.dazzleconf.engine.liaison.BooleanDefault
-
The boolean value to provide as an "if missing" default.
- ifMissing() - Element in annotation type space.arim.dazzleconf.engine.liaison.ByteDefault
-
The byte value to provide as an "if missing" default.
- ifMissing() - Element in annotation type space.arim.dazzleconf.engine.liaison.DoubleDefault
-
The double value to provide as an "if missing" default.
- ifMissing() - Element in annotation type space.arim.dazzleconf.engine.liaison.FloatDefault
-
The float value to provide as an "if missing" default.
- ifMissing() - Element in annotation type space.arim.dazzleconf.engine.liaison.IntegerDefault
-
The int value to provide as an "if missing" default.
- ifMissing() - Element in annotation type space.arim.dazzleconf.engine.liaison.LongDefault
-
The long value to provide as an "if missing" default.
- ifMissing() - Element in annotation type space.arim.dazzleconf.engine.liaison.ShortDefault
-
The short value to provide as an "if missing" default.
- ifMissing() - Element in annotation type space.arim.dazzleconf.engine.liaison.StringDefault
-
The string value to provide as an "if missing" default.
- ifSuccess(Consumer<? super R>) - Method in class space.arim.dazzleconf.LoadResult
-
Runs an action on the success value.
- Immut() - Constructor for class space.arim.dazzleconf.backend.DataList.Immut
-
Creates an empty data list
- Immut() - Constructor for class space.arim.dazzleconf.backend.DataTree.Immut
-
Creates an empty data tree
- Immut() - Constructor for class space.arim.dazzleconf.backend.KeyPath.Immut
-
Creates an empty key path
- Immut(String...) - Constructor for class space.arim.dazzleconf.backend.KeyPath.Immut
-
Creates from the given parts
- Immut(Collection<DataEntry>) - Constructor for class space.arim.dazzleconf.backend.DataList.Immut
-
Creates from the given elements.
- Immut(DataEntry...) - Constructor for class space.arim.dazzleconf.backend.DataList.Immut
-
Creates from the given elements.
- Immut(KeyPath) - Constructor for class space.arim.dazzleconf.backend.KeyPath.Immut
-
Creates from another key path.
- implementable() - Method in class space.arim.dazzleconf.reflect.MethodYield.Entry
-
Gets the interface being implemented
- INLINE - Enum constant in enum space.arim.dazzleconf.engine.CommentLocation
-
Inline to the entry.
- InputOutputRoot - Class in space.arim.dazzleconf.backend
-
A base class for data root that makes use of
InputStreamandOutputStream. - InputOutputRoot(Charset) - Constructor for class space.arim.dazzleconf.backend.InputOutputRoot
-
Sets the charset to use for read/write operations involving textual streams
- Instantiator - Interface in space.arim.dazzleconf.reflect
-
Service capable of generating runtime implementations of interfaces.
- IntegerDefault - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Specifies the default value as an integer.
- IntegerLiaison - Class in space.arim.dazzleconf.engine.liaison
-
Liaison for integers
- IntegerLiaison() - Constructor for class space.arim.dazzleconf.engine.liaison.IntegerLiaison
-
Creates
- IntegerRange - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Controls the range of an int.
- intoImmut() - Method in class space.arim.dazzleconf.backend.DataList.Immut
- intoImmut() - Method in class space.arim.dazzleconf.backend.DataList
-
Gets this data tree as an immutable one.
- intoImmut() - Method in class space.arim.dazzleconf.backend.DataList.Mut
- intoImmut() - Method in class space.arim.dazzleconf.backend.DataTree.Immut
- intoImmut() - Method in class space.arim.dazzleconf.backend.DataTree
-
Gets this data tree as an immutable one.
- intoImmut() - Method in class space.arim.dazzleconf.backend.DataTree.Mut
- intoImmut() - Method in class space.arim.dazzleconf.backend.KeyPath.Immut
- intoImmut() - Method in class space.arim.dazzleconf.backend.KeyPath
-
Gets this key path as an immutable one.
- intoImmut() - Method in class space.arim.dazzleconf.backend.KeyPath.Mut
- intoMut() - Method in class space.arim.dazzleconf.backend.DataList.Immut
- intoMut() - Method in class space.arim.dazzleconf.backend.DataList
-
Gets this data list as a mutable one.
- intoMut() - Method in class space.arim.dazzleconf.backend.DataList.Mut
- intoMut() - Method in class space.arim.dazzleconf.backend.DataTree.Immut
- intoMut() - Method in class space.arim.dazzleconf.backend.DataTree
-
Gets this data tree as a mutable one.
- intoMut() - Method in class space.arim.dazzleconf.backend.DataTree.Mut
- intoMut() - Method in class space.arim.dazzleconf.backend.KeyPath.Immut
- intoMut() - Method in class space.arim.dazzleconf.backend.KeyPath
-
Gets this key path as a mutable one.
- intoMut() - Method in class space.arim.dazzleconf.backend.KeyPath.Mut
- intoParts() - Method in class space.arim.dazzleconf.backend.KeyPath
-
Turns into key path parts.
- intoPartsList() - Method in class space.arim.dazzleconf.backend.KeyPath
-
Same as
KeyPath.intoParts()but returns a list. - InvokeDefaultFunction - Class in space.arim.dazzleconf.reflect
-
A marker value used for
MethodYieldthat instructs theInstantiatorto call the default method. - InvokeDefaultFunction() - Constructor for class space.arim.dazzleconf.reflect.InvokeDefaultFunction
-
Creates
- invokeMethod(MethodId, Object...) - Method in interface space.arim.dazzleconf.reflect.MethodMirror.Invoker
-
Invokes a method and gets the return value.
- isAnnotationPresent(Class<? extends Annotation>) - Method in class space.arim.dazzleconf.reflect.ReifiedType.Annotated
- isDefault() - Method in class space.arim.dazzleconf.reflect.MethodId
-
Gets whether the method is implemented by default
- isEmpty() - Method in class space.arim.dazzleconf.backend.CommentData
-
Gets whether there are no comments
- isEmpty() - Method in class space.arim.dazzleconf.backend.DataList.Immut
- isEmpty() - Method in class space.arim.dazzleconf.backend.DataList
-
Whether this data list is devoid of elements
- isEmpty() - Method in class space.arim.dazzleconf.backend.DataList.Mut
- isEmpty() - Method in class space.arim.dazzleconf.backend.DataTree
-
Whether this data tree is devoid of key/value pairs
- isEmpty() - Method in class space.arim.dazzleconf.backend.KeyPath
-
Whether this key path is empty
- isFailure() - Method in class space.arim.dazzleconf.LoadResult
-
Checks if failed.
- isSuccess() - Method in class space.arim.dazzleconf.LoadResult
-
Checks if succeeded.
- isUsable(C_OLD) - Method in interface space.arim.dazzleconf.migration.MigrateSource.Filter
-
Checks whether the given old configuration should be used.
- iterateFrom(KeyPath.SequenceBoundary, Consumer<? super CharSequence>) - Method in class space.arim.dazzleconf.backend.KeyPath
-
Runs an action for each key part in the sequence.
J
- join(Printable...) - Static method in interface space.arim.dazzleconf.backend.Printable
-
Joins multiple printable values, appending them one after the other.
K
- KebabCaseKeyMapper - Class in space.arim.dazzleconf.backend
-
A key mapper which converts lower camel case patterns to kebab case.
- KebabCaseKeyMapper() - Constructor for class space.arim.dazzleconf.backend.KebabCaseKeyMapper
-
Creates
- keyMapper() - Method in interface space.arim.dazzleconf.ConfigurationDefinition.ReadOptions
-
The key mapper to use
- keyMapper() - Method in interface space.arim.dazzleconf.ConfigurationDefinition.WriteOptions
-
The key mapper to use
- keyMapper() - Method in interface space.arim.dazzleconf.engine.DeserializeContext
-
Gets the key mapper.
- keyMapper() - Method in interface space.arim.dazzleconf.engine.SerializeContext
-
Gets the key mapper being used
- keyMapper(KeyMapper) - Method in class space.arim.dazzleconf.ConfigurationBuilder
-
Sets the key mapper
- KeyMapper - Interface in space.arim.dazzleconf.backend
-
Simple interface for mapping method names into backend configuration keys, and vice versa.
- keyPath() - Method in interface space.arim.dazzleconf.ConfigurationDefinition.ReadOptions
-
Gets the absolute key path at which the configuration is being read.
- keyPath() - Method in interface space.arim.dazzleconf.engine.DeserializeContext
-
Gets the absolute key path of the enclosing context.
- KeyPath - Class in space.arim.dazzleconf.backend
-
A key path consists of an ordered sequence of strings.
- KeyPath.Immut - Class in space.arim.dazzleconf.backend
-
A key path which is unmistakably immutable.
- KeyPath.Mut - Class in space.arim.dazzleconf.backend
- KeyPath.SequenceBoundary - Enum in space.arim.dazzleconf.backend
-
Specifies either the start or the end of the key path sequence.
- keySet() - Method in class space.arim.dazzleconf.backend.DataTree
-
Gets all the keys in this data tree.
L
- label() - Method in interface space.arim.dazzleconf.engine.TypeLiaison.DefaultInit
-
The label for the entry, typically the method name
- labelToKey(CharSequence) - Method in class space.arim.dazzleconf.backend.DefaultKeyMapper
- labelToKey(CharSequence) - Method in class space.arim.dazzleconf.backend.KebabCaseKeyMapper
- labelToKey(CharSequence) - Method in interface space.arim.dazzleconf.backend.KeyMapper
-
Turns the argument into a key.
- labelToKey(CharSequence) - Method in class space.arim.dazzleconf.backend.LowerSnakeCaseKeyMapper
- LINE_NUMBER - Static variable in interface space.arim.dazzleconf.ErrorContext
-
Line number in the source data
- load(MigrateContext) - Method in class space.arim.dazzleconf.migration.MigrateFromConfiguration
- load(MigrateContext) - Method in interface space.arim.dazzleconf.migration.MigrateSource
-
Attempts to load this configuration version.
- loadDefaults() - Method in interface space.arim.dazzleconf.ConfigurationDefinition
-
Loads the default configuration.
- loadDefaultValues(TypeLiaison.DefaultInit<V>) - Method in interface space.arim.dazzleconf.engine.TypeLiaison.Agent
-
Gets default values.
- LoadResult<R> - Class in space.arim.dazzleconf
-
A result container for fallible operations.
- locale(Locale) - Method in class space.arim.dazzleconf.ConfigurationBuilder
-
Sets the locale for displaying error messages.
- location() - Element in annotation type space.arim.dazzleconf.engine.Comments
-
Where the comments should be located.
- LongDefault - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Specifies the default value as a long
- LongLiaison - Class in space.arim.dazzleconf.engine.liaison
-
Liaison for longs
- LongLiaison() - Constructor for class space.arim.dazzleconf.engine.liaison.LongLiaison
-
Creates
- LongRange - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Controls the range of a long.
- lookup(MethodHandles.Lookup) - Method in class space.arim.dazzleconf.ConfigurationBuilder
-
Changes the lookup used by the library for reflective access.
- LowerSnakeCaseKeyMapper - Class in space.arim.dazzleconf.backend
-
A key mapper which converts lower camel case patterns to snake case.
- LowerSnakeCaseKeyMapper() - Constructor for class space.arim.dazzleconf.backend.LowerSnakeCaseKeyMapper
-
Creates
M
- mainBackend() - Method in interface space.arim.dazzleconf.migration.MigrateContext
-
The backend being used to load the main configuration.
- mainMessage() - Method in interface space.arim.dazzleconf.ErrorContext
-
Gets the main message to display as the reason for this error.
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.ByteLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.DoubleLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.FloatLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.IntegerLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.LongLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.ShortLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.BooleanLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.CharacterLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.CollectionLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.EnumLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.MapLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.SimpleTypeLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.StringLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf.engine.liaison.SubSectionLiaison
- makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in interface space.arim.dazzleconf.engine.TypeLiaison
-
Attempts to support the following type.
- makeChild(Object) - Method in interface space.arim.dazzleconf.engine.DeserializeInput
-
Deprecated.
- makeChild(DataEntry, Object) - Method in interface space.arim.dazzleconf.engine.DeserializeInput
-
Makes a child at the given subkey and prepares it for deserialization.
- makeErrorSource() - Method in interface space.arim.dazzleconf.Configuration
-
Creates a convenient error source.
- makeInstantiator(MethodHandles.Lookup) - Method in class space.arim.dazzleconf.reflect.DefaultReflectionService
- makeInstantiator(MethodHandles.Lookup) - Method in interface space.arim.dazzleconf.reflect.ReflectionService
-
Gets the instantiator this service provides.
- makeInvoker(Object, Class<?>) - Method in interface space.arim.dazzleconf.reflect.MethodMirror
-
Creates an invoker that allows calling methods on the given receiver.
- makeMethodMirror(MethodHandles.Lookup) - Method in class space.arim.dazzleconf.reflect.DefaultReflectionService
- makeMethodMirror(MethodHandles.Lookup) - Method in interface space.arim.dazzleconf.reflect.ReflectionService
-
Gets the
MethodMirrorthis service provides. - makeReloadShell(C) - Method in interface space.arim.dazzleconf.Configuration
-
Creates a reload shell for this configuration.
- makeSerializer() - Method in interface space.arim.dazzleconf.engine.TypeLiaison.Agent
-
Makes a serializer for the type.
- map(Function<? super R, R_NEW>) - Method in class space.arim.dazzleconf.LoadResult
-
Maps from one load result to another.
- MapLiaison - Class in space.arim.dazzleconf.engine.liaison
-
Liaison for maps.
- MapLiaison() - Constructor for class space.arim.dazzleconf.engine.liaison.MapLiaison
-
Creates the liaison
- matchOnToken(TypeToken<R>, Class<V>, Supplier<TypeLiaison.Agent<V>>) - Static method in interface space.arim.dazzleconf.engine.TypeLiaison.Agent
-
A convenience API for cast-free, generic-safe agent creation, given raw type
V. - max() - Element in annotation type space.arim.dazzleconf.engine.liaison.ByteRange
-
The maximum value
- max() - Element in annotation type space.arim.dazzleconf.engine.liaison.DoubleRange
-
The maximum value.
- max() - Element in annotation type space.arim.dazzleconf.engine.liaison.FloatRange
-
The maximum value.
- max() - Element in annotation type space.arim.dazzleconf.engine.liaison.IntegerRange
-
The maximum value.
- max() - Element in annotation type space.arim.dazzleconf.engine.liaison.LongRange
-
The maximum value
- max() - Element in annotation type space.arim.dazzleconf.engine.liaison.ShortRange
-
The maximum value
- maximumErrorCollect() - Method in interface space.arim.dazzleconf.ConfigurationDefinition.ReadOptions
-
The maximum number of errors to collect before exiting.
- meta() - Method in interface space.arim.dazzleconf.backend.Backend
-
Gets information about this backend itself.
- method() - Method in class space.arim.dazzleconf.reflect.MethodYield.Entry
-
Gets the method
- methodAnnotations() - Method in interface space.arim.dazzleconf.engine.TypeLiaison.DefaultInit
-
Gets method level annotations for the entry being initialized
- methodDefault() - Method in interface space.arim.dazzleconf.engine.TypeLiaison.DefaultInit
-
Extracts default values from the default method if one exists.
- MethodId - Class in space.arim.dazzleconf.reflect
-
Identifiers for a method.
- MethodId(String, ReifiedType.Annotated, ReifiedType[], boolean) - Constructor for class space.arim.dazzleconf.reflect.MethodId
-
Builds from arguments
- MethodId.OpaqueCache - Interface in space.arim.dazzleconf.reflect
-
A marker interface for cache data appended to a
MethodId. - MethodMirror - Interface in space.arim.dazzleconf.reflect
-
Service for traversing a type hierarchy and getting and invoking methods on types in that hierarchy.
- MethodMirror.Invoker - Interface in space.arim.dazzleconf.reflect
-
A wrapper for an instance whose methods can be called, as long as those methods conform to a certain enclosing type.
- MethodMirror.TypeWalker - Interface in space.arim.dazzleconf.reflect
-
Controller for accessing the reflected methods of a given type
- MethodYield - Class in space.arim.dazzleconf.reflect
-
Bank of values yielded when calling an instantiated proxy.
- MethodYield() - Constructor for class space.arim.dazzleconf.reflect.MethodYield
-
Creates an empty yield.
- MethodYield.Entry - Class in space.arim.dazzleconf.reflect
-
An entry added to the method yield
- MethodYield.ForImplementable - Class in space.arim.dazzleconf.reflect
-
Builder of return value instructions, given an implementable class.
- MigrateContext - Interface in space.arim.dazzleconf.migration
-
Contextual resources to be used by migrations.
- MIGRATED - Enum constant in enum space.arim.dazzleconf.engine.UpdateReason
-
Used in context of migrations, such as changes in the organization or format of the config.
- migratedFrom(Migration<?, ?>) - Method in interface space.arim.dazzleconf.ConfigureListener
-
Notifies that a migration was successful.
- migrateFrom(C_OLD, MigrateContext) - Method in interface space.arim.dazzleconf.migration.Transition
-
Migrates from one configuration to another
- MigrateFromConfiguration<C> - Class in space.arim.dazzleconf.migration
-
A migration source from another configuration with this library.
- MigrateFromConfiguration(Configuration<C>) - Constructor for class space.arim.dazzleconf.migration.MigrateFromConfiguration
-
Creates
- MigrateSource<C> - Interface in space.arim.dazzleconf.migration
-
A source for an old configuration version.
- MigrateSource.Filter<C_OLD> - Interface in space.arim.dazzleconf.migration
-
A filter for old configuration versions.
- Migration<C_OLD,
C_NEW> - Class in space.arim.dazzleconf.migration -
A migration package
- Migration(MigrateSource<C_OLD>, Transition<C_OLD, C_NEW>) - Constructor for class space.arim.dazzleconf.migration.Migration
-
Creates from a source and transition
- migrationSkip(Migration<?, ?>, List<ErrorContext>) - Method in interface space.arim.dazzleconf.ConfigureListener
-
Notifies that a migration was attempted, but it failed (for any reason).
- min() - Element in annotation type space.arim.dazzleconf.engine.liaison.ByteRange
-
The minimum value
- min() - Element in annotation type space.arim.dazzleconf.engine.liaison.DoubleRange
-
The minimum value.
- min() - Element in annotation type space.arim.dazzleconf.engine.liaison.FloatRange
-
The minimum value.
- min() - Element in annotation type space.arim.dazzleconf.engine.liaison.IntegerRange
-
The minimum value.
- min() - Element in annotation type space.arim.dazzleconf.engine.liaison.LongRange
-
The minimum value
- min() - Element in annotation type space.arim.dazzleconf.engine.liaison.ShortRange
-
The minimum value
- MISSING - Enum constant in enum space.arim.dazzleconf.engine.UpdateReason
-
Used when an option was missing, so the value was supplied with
DefaultValues.ifMissing(). - Mut() - Constructor for class space.arim.dazzleconf.backend.DataList.Mut
-
Creates
- Mut() - Constructor for class space.arim.dazzleconf.backend.DataTree.Mut
-
Creates
- Mut() - Constructor for class space.arim.dazzleconf.backend.KeyPath.Mut
-
Creates an empty key path
- Mut(int) - Constructor for class space.arim.dazzleconf.backend.DataList.Mut
-
Creates with a capacity hint
- Mut(String...) - Constructor for class space.arim.dazzleconf.backend.KeyPath.Mut
-
Creates from the given parts
- Mut(Collection<DataEntry>) - Constructor for class space.arim.dazzleconf.backend.DataList.Mut
-
Creates from the given elements.
- Mut(DataEntry...) - Constructor for class space.arim.dazzleconf.backend.DataList.Mut
-
Creates from the given elements.
- Mut(KeyPath) - Constructor for class space.arim.dazzleconf.backend.KeyPath.Mut
-
Creates from another key path.
N
- name() - Method in class space.arim.dazzleconf.reflect.MethodId
-
The method name
- notifyUpdate(KeyPath, UpdateReason) - Method in interface space.arim.dazzleconf.engine.DeserializeContext
-
Signals that the data could use an update with respect to this object.
- notifyUpdate(KeyPath, UpdateReason) - Method in interface space.arim.dazzleconf.engine.UpdateListener
-
Called when a path is updated, or could be updated.
- notifyUpdate(KeyPath, UpdateReason) - Method in interface space.arim.dazzleconf.migration.MigrateContext
-
Allows migrations to signal updated paths.
O
- object() - Method in interface space.arim.dazzleconf.engine.DeserializeInput
-
The actual object which is being deserialized.
- of(R) - Static method in class space.arim.dazzleconf.LoadResult
-
Makes a successful load result
- onCompletion() - Method in class space.arim.dazzleconf.migration.MigrateFromConfiguration
- onCompletion() - Method in interface space.arim.dazzleconf.migration.MigrateSource
-
Signals that the migration was fully completed.
- onCompletion() - Method in class space.arim.dazzleconf.migration.Migration
-
Signals that the migration was fully completed.
- onError(List<ErrorContext>) - Method in interface space.arim.dazzleconf.ErrorPrint
-
Displays the following error contexts in some way, shape, or form
- onError(List<ErrorContext>) - Method in class space.arim.dazzleconf.StandardErrorPrint
- openInputStream(DataRoot.Operation<R, InputStream>) - Method in interface space.arim.dazzleconf.backend.BinaryRoot
-
Opens an input stream for the data
- openInputStream(DataRoot.Operation<R, InputStream>) - Method in class space.arim.dazzleconf.backend.PathRoot
- openOutputStream(DataRoot.Operation<R, OutputStream>) - Method in interface space.arim.dazzleconf.backend.BinaryRoot
-
Opens an output stream to the data
- openOutputStream(DataRoot.Operation<R, OutputStream>) - Method in class space.arim.dazzleconf.backend.PathRoot
- openReadChannel(DataRoot.Operation<R, ReadableByteChannel>) - Method in interface space.arim.dazzleconf.backend.BinaryRoot
-
Opens a read channel for the data
- openReadChannel(DataRoot.Operation<R, ReadableByteChannel>) - Method in class space.arim.dazzleconf.backend.InputOutputRoot
- openReadChannel(DataRoot.Operation<R, ReadableByteChannel>) - Method in class space.arim.dazzleconf.backend.PathRoot
- openReader(DataRoot.Operation<R, Reader>) - Method in class space.arim.dazzleconf.backend.InputOutputRoot
- openReader(DataRoot.Operation<R, Reader>) - Method in class space.arim.dazzleconf.backend.PathRoot
- openReader(DataRoot.Operation<R, Reader>) - Method in interface space.arim.dazzleconf.backend.ReadableRoot
-
Opens a reader to the data
- openReader(DataRoot.Operation<R, Reader>) - Method in class space.arim.dazzleconf.backend.StringRoot
- openWriteChannel(DataRoot.Operation<R, WritableByteChannel>) - Method in interface space.arim.dazzleconf.backend.BinaryRoot
-
Opens a write channel to the data
- openWriteChannel(DataRoot.Operation<R, WritableByteChannel>) - Method in class space.arim.dazzleconf.backend.InputOutputRoot
- openWriteChannel(DataRoot.Operation<R, WritableByteChannel>) - Method in class space.arim.dazzleconf.backend.PathRoot
- openWriter(DataRoot.Operation<R, Writer>) - Method in class space.arim.dazzleconf.backend.InputOutputRoot
- openWriter(DataRoot.Operation<R, Writer>) - Method in class space.arim.dazzleconf.backend.PathRoot
- openWriter(DataRoot.Operation<R, Writer>) - Method in interface space.arim.dazzleconf.backend.ReadableRoot
-
Opens a writer for the data
- openWriter(DataRoot.Operation<R, Writer>) - Method in class space.arim.dazzleconf.backend.StringRoot
- operateUsing(U) - Method in interface space.arim.dazzleconf.backend.DataRoot.Operation
-
Performs the operation
- opposite() - Method in enum space.arim.dazzleconf.backend.KeyPath.SequenceBoundary
-
Returns the opposite boundary of this one.
- OTHER - Enum constant in enum space.arim.dazzleconf.engine.UpdateReason
-
A catch-all for other or unknown reasons.
- outBoolean(boolean) - Method in interface space.arim.dazzleconf.engine.SerializeOutput
-
Outputs a boolean
- outByte(byte) - Method in interface space.arim.dazzleconf.engine.SerializeOutput
-
Outputs a byte
- outChar(char) - Method in interface space.arim.dazzleconf.engine.SerializeOutput
-
Outputs a character
- outDataList(DataList) - Method in interface space.arim.dazzleconf.engine.SerializeOutput
-
Outputs a data list
- outDataTree(DataTree) - Method in interface space.arim.dazzleconf.engine.SerializeOutput
-
Outputs a data tree
- outDouble(double) - Method in interface space.arim.dazzleconf.engine.SerializeOutput
-
Outputs a double
- outFloat(float) - Method in interface space.arim.dazzleconf.engine.SerializeOutput
-
Outputs a float
- outInt(int) - Method in interface space.arim.dazzleconf.engine.SerializeOutput
-
Outputs an integer
- outLong(long) - Method in interface space.arim.dazzleconf.engine.SerializeOutput
-
Outputs a long
- outObjectUnchecked(Object) - Method in interface space.arim.dazzleconf.engine.SerializeOutput
-
Outputs the given object.
- output(Printable) - Method in interface space.arim.dazzleconf.ErrorPrint.Output
-
Outputs the given printable content
- outShort(short) - Method in interface space.arim.dazzleconf.engine.SerializeOutput
-
Outputs a short
- outString(String) - Method in interface space.arim.dazzleconf.engine.SerializeOutput
-
Outputs a string
P
- parameterAt(int) - Method in class space.arim.dazzleconf.reflect.MethodId
-
Gets the parameter at a certain index
- parameterCount() - Method in class space.arim.dazzleconf.reflect.MethodId
-
The parameter count
- parameters() - Method in class space.arim.dazzleconf.reflect.MethodId
-
Gets all the parameters
- PathRoot - Class in space.arim.dazzleconf.backend
-
A data root from a file path.
- PathRoot(Path) - Constructor for class space.arim.dazzleconf.backend.PathRoot
-
Creates from a path.
- PathRoot(Path, Charset) - Constructor for class space.arim.dazzleconf.backend.PathRoot
-
Creates from a path and a charset.
- preBuilt(CharSequence) - Static method in interface space.arim.dazzleconf.backend.Printable
-
Makes a simple implementation based on an existing string.
- preservesOrder(boolean) - Method in interface space.arim.dazzleconf.backend.Backend.Meta
-
Whether this backend supports preservation of data entry order.
- Printable - Interface in space.arim.dazzleconf.backend
-
A displayable item, printed in one of multiple ways.
- Printable.Abstract - Class in space.arim.dazzleconf.backend
-
A base implementation for
Printable. - printString() - Method in class space.arim.dazzleconf.backend.KeyPath
- printString() - Method in class space.arim.dazzleconf.backend.Printable.Abstract
- printString() - Method in interface space.arim.dazzleconf.backend.Printable
-
Gets the printed content as a string
- printTo(Appendable) - Method in class space.arim.dazzleconf.backend.KeyPath
- printTo(Appendable) - Method in interface space.arim.dazzleconf.backend.Printable
-
Prints to the given appendable
- printTo(StringBuilder) - Method in class space.arim.dazzleconf.backend.KeyPath
- printTo(StringBuilder) - Method in class space.arim.dazzleconf.backend.Printable.Abstract
- printTo(StringBuilder) - Method in interface space.arim.dazzleconf.backend.Printable
-
Prints to the given builder
- put(Object, DataEntry) - Method in class space.arim.dazzleconf.backend.DataTree.Mut
-
Sets the entry at the specified key.
Q
- query(ErrorContext.Key<V>) - Method in interface space.arim.dazzleconf.ErrorContext
-
Gets a piece of detail from this error context, if it is set
R
- rawType() - Method in class space.arim.dazzleconf.reflect.ReifiedType
-
Gets the raw type, unparameterized
- read(ErrorContext.Source) - Method in interface space.arim.dazzleconf.backend.Backend
-
Reads data.
- ReadableRoot - Interface in space.arim.dazzleconf.backend
-
Unifying interface for string based data roots.
- readFrom(DataTree) - Method in interface space.arim.dazzleconf.Configuration
-
A simple, stateless read from a data tree.
- readFrom(DataTree, ConfigurationDefinition.ReadOptions) - Method in interface space.arim.dazzleconf.ConfigurationDefinition
-
A simple, stateless read from a data tree.
- readFrom(DataTree, UpdateListener) - Method in interface space.arim.dazzleconf.Configuration
-
A simple, stateless read from a data tree.
- readString() - Method in class space.arim.dazzleconf.backend.InputOutputRoot
- readString() - Method in class space.arim.dazzleconf.backend.PathRoot
- readString() - Method in interface space.arim.dazzleconf.backend.ReadableRoot
-
Reads to a string
- readString() - Method in class space.arim.dazzleconf.backend.StringRoot
- readWithUpdate(DataTree.Mut, ConfigurationDefinition.ReadWithUpdateOptions) - Method in interface space.arim.dazzleconf.ConfigurationDefinition
-
Reads from the data tree given, and updates it as necessary.
- recommendKeyMapper() - Method in interface space.arim.dazzleconf.backend.Backend
-
Recommends a
KeyMapperappropriate to the backend format. - reflectionService(ReflectionService) - Method in class space.arim.dazzleconf.ConfigurationBuilder
-
Sets the reflection service.
- ReflectionService - Interface in space.arim.dazzleconf.reflect
-
A low-level service responsible for generating, instantiating, and invoking methods on arbitrary interface implementations.
- ReifiedType - Class in space.arim.dazzleconf.reflect
-
A possibly generic type, with its arguments fully specified.
- ReifiedType(Class<?>, ReifiedType[]) - Constructor for class space.arim.dazzleconf.reflect.ReifiedType
-
Builds from nonnull input arguments.
- ReifiedType.Annotated - Class in space.arim.dazzleconf.reflect
-
Annotation capable extension to a reified type.
- ReloadShell<C> - Interface in space.arim.dazzleconf
-
A handler for managing reloading of an inner configuration object.
- remove(Object) - Method in class space.arim.dazzleconf.backend.DataTree.Mut
-
Clears any entry at the specified key
- requireDataList() - Method in interface space.arim.dazzleconf.engine.DeserializeInput
-
Requires the object to be a list of data entries.
- requireDataTree() - Method in interface space.arim.dazzleconf.engine.DeserializeInput
-
Requires the object to be a data tree, i.e.
- requireString() - Method in interface space.arim.dazzleconf.engine.DeserializeInput
-
Requires the object to be a string
- returnType() - Method in class space.arim.dazzleconf.reflect.MethodId
-
The return type
- returnValue() - Method in class space.arim.dazzleconf.reflect.MethodYield.Entry
-
Gets the return value for the method, or
InvokeDefaultFunctionto call the default implementation - returnValue(MethodId, Object) - Method in class space.arim.dazzleconf.reflect.MethodYield.ForImplementable
-
Specifies to return the given value.
S
- serialize(V, SerializeOutput) - Method in interface space.arim.dazzleconf.engine.SerializeDeserialize
-
Serializes this value.
- SerializeContext - Interface in space.arim.dazzleconf.engine
-
A context for serialization.
- SerializeDeserialize<V> - Interface in space.arim.dazzleconf.engine
-
A serializer.
- SerializeOutput - Interface in space.arim.dazzleconf.engine
-
The output for serialization, which is handed to
SerializeDeserialize.serialize(V, space.arim.dazzleconf.engine.SerializeOutput). - set(int, DataEntry) - Method in class space.arim.dazzleconf.backend.DataList.Mut
-
Replaces the element at the given index
- setAt(CommentLocation, String...) - Method in class space.arim.dazzleconf.backend.CommentData
-
Attaches comments and returns a new object.
- setAt(CommentLocation, List<String>) - Method in class space.arim.dazzleconf.backend.CommentData
-
Attaches comments and returns a new object.
- setCurrentDelegate(C) - Method in interface space.arim.dazzleconf.ReloadShell
-
Sets the inner configuration object to the provided value.
- ShortDefault - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Specifies the default value as a short.
- ShortLiaison - Class in space.arim.dazzleconf.engine.liaison
-
Liaison for shorts
- ShortLiaison() - Constructor for class space.arim.dazzleconf.engine.liaison.ShortLiaison
-
Creates
- ShortRange - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Controls the range of a short.
- simple(V) - Static method in interface space.arim.dazzleconf.engine.DefaultValues
-
Creates a simple implementation from the given value.
- simple(DataTree) - Static method in interface space.arim.dazzleconf.backend.Backend.Document
-
Returns a document consisting of the following data, without commments
- SimpleTypeLiaison<U> - Class in space.arim.dazzleconf.engine.liaison
-
A simple type liaison that wraps a
SerializeDeserialize. - SimpleTypeLiaison(TypeToken<U>, SerializeDeserialize<U>) - Constructor for class space.arim.dazzleconf.engine.liaison.SimpleTypeLiaison
-
Creates from a type token and the provided serialization
- size() - Method in class space.arim.dazzleconf.backend.DataList.Immut
- size() - Method in class space.arim.dazzleconf.backend.DataList.Mut
- size() - Method in class space.arim.dazzleconf.backend.DataList
-
The number of elements in this data tree indicates its size
- size() - Method in class space.arim.dazzleconf.backend.DataTree
-
The number of key/value pairs in this data tree indicates its size
- size() - Method in class space.arim.dazzleconf.backend.KeyPath
-
Gets the number of key parts in the sequence
- sizeEstimate() - Method in class space.arim.dazzleconf.reflect.MethodYield
-
Gets the estimated number of entries
- space.arim.dazzleconf - package space.arim.dazzleconf
-
Version 2 of the library, provided as a separate package.
- space.arim.dazzleconf.backend - package space.arim.dazzleconf.backend
-
This package defines a framework for interactions between the library and the configuration format.
- space.arim.dazzleconf.engine - package space.arim.dazzleconf.engine
- space.arim.dazzleconf.engine.liaison - package space.arim.dazzleconf.engine.liaison
- space.arim.dazzleconf.migration - package space.arim.dazzleconf.migration
-
An optional API for migrations.
- space.arim.dazzleconf.reflect - package space.arim.dazzleconf.reflect
- StandardErrorPrint - Class in space.arim.dazzleconf
-
Usable implementation of
ErrorPrintthat formats the error message in a language-independent fashion. - StandardErrorPrint(ErrorPrint.Output) - Constructor for class space.arim.dazzleconf.StandardErrorPrint
-
Creates from the given output
- StringDefault - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Specifies the default value as string.
- StringLiaison - Class in space.arim.dazzleconf.engine.liaison
-
Liaison for strings.
- StringLiaison() - Constructor for class space.arim.dazzleconf.engine.liaison.StringLiaison
-
Creates
- StringRoot - Class in space.arim.dazzleconf.backend
-
Implementation of data root for a string
- StringRoot(String) - Constructor for class space.arim.dazzleconf.backend.StringRoot
-
Creates from the given initial ccontent
- SubSection - Annotation Type in space.arim.dazzleconf.engine.liaison
-
Specifies that an interface is a configuration subsection.
- SubSectionLiaison - Class in space.arim.dazzleconf.engine.liaison
-
A type liaison that enables using subsection configurations.
- SubSectionLiaison() - Constructor for class space.arim.dazzleconf.engine.liaison.SubSectionLiaison
-
Creates
- supportsComments(boolean, boolean, CommentLocation) - Method in interface space.arim.dazzleconf.backend.Backend.Meta
-
Whether comments are supported in the following context.
- SYNTAX_LINTER - Static variable in interface space.arim.dazzleconf.ErrorContext
-
A URL pointing to an online syntax linter.
T
- throwError(CharSequence) - Method in interface space.arim.dazzleconf.ErrorContext.Source
-
Builds an error context, wraps it in a
LoadResultand returns it. - throwError(Printable) - Method in interface space.arim.dazzleconf.ErrorContext.Source
-
Builds an error context, wraps it in a
LoadResultand returns it. - toString() - Method in class space.arim.dazzleconf.backend.CommentData
- toString() - Method in class space.arim.dazzleconf.backend.DataEntry
- toString() - Method in class space.arim.dazzleconf.backend.DataList
- toString() - Method in class space.arim.dazzleconf.backend.DataTree
- toString() - Method in class space.arim.dazzleconf.backend.KeyPath
- toString() - Method in class space.arim.dazzleconf.backend.Printable.Abstract
- toString() - Method in interface space.arim.dazzleconf.backend.Printable
-
Gets a string representation.
- toString() - Method in class space.arim.dazzleconf.LoadResult
- toString() - Method in class space.arim.dazzleconf.reflect.MethodId
- toString() - Method in class space.arim.dazzleconf.reflect.MethodYield
- toString() - Method in class space.arim.dazzleconf.reflect.ReifiedType
- toString() - Method in class space.arim.dazzleconf.reflect.TypeToken
- Transition<C_OLD,
C_NEW> - Interface in space.arim.dazzleconf.migration -
Converter interface for moving from one configuration object to another
- tryMigrate(MigrateContext) - Method in class space.arim.dazzleconf.migration.Migration
-
Tries to migrate.
- TypeLiaison - Interface in space.arim.dazzleconf.engine
-
Powerful handle for working with types, serializing them, and representing them throughout the library structure and configuration construction process.
- TypeLiaison.Agent<V> - Interface in space.arim.dazzleconf.engine
-
An agent that is ready to handle matters relating to a type
- TypeLiaison.DefaultInit<V> - Interface in space.arim.dazzleconf.engine
-
Provides relevant resources related to default value creation
- TypeLiaison.Handshake - Interface in space.arim.dazzleconf.engine
-
Callback interface allowing
TypeLiaison.Agentto access certain resources - TypeToken<V> - Class in space.arim.dazzleconf.reflect
-
Token for handling configuration-related types at runtime.
- TypeToken() - Constructor for class space.arim.dazzleconf.reflect.TypeToken
-
Creates from a subclass.
- TypeToken(ReifiedType.Annotated) - Constructor for class space.arim.dazzleconf.reflect.TypeToken
-
Creates from a reified type.
- typeWalker(ReifiedType.Annotated) - Method in interface space.arim.dazzleconf.reflect.MethodMirror
-
Makes a type walker for the given type.
U
- unannotated() - Static method in class space.arim.dazzleconf.reflect.ReifiedType.Annotated
-
Gets a dummy annotated element, containing no annotations.
- unannotated(Class<?>) - Static method in class space.arim.dazzleconf.reflect.ReifiedType.Annotated
-
Creates an unparameterized, unannotated reified type for the following raw class.
- UPDATED - Enum constant in enum space.arim.dazzleconf.engine.UpdateReason
-
An existing option was updated to another value.
- UpdateListener - Interface in space.arim.dazzleconf.engine
-
Listener that lets the implementor know when paths were updated.
- UpdateReason - Enum in space.arim.dazzleconf.engine
-
A reason why a particular path within a configuration was updated
V
- validateKey(Object) - Static method in class space.arim.dazzleconf.backend.DataTree
-
Checks whether the given object is valid as a key in the data tree.
- validateValue(Object) - Static method in class space.arim.dazzleconf.backend.DataEntry
-
Checks whether the given object is valid as a value.
- value() - Element in annotation type space.arim.dazzleconf.engine.Comments.Container
-
The values in this container.
- value() - Element in annotation type space.arim.dazzleconf.engine.Comments
-
The comments themselves.
- value() - Element in annotation type space.arim.dazzleconf.engine.liaison.BooleanDefault
-
The boolean value to provide as a default
- value() - Element in annotation type space.arim.dazzleconf.engine.liaison.ByteDefault
-
The byte value to provide as a default
- value() - Element in annotation type space.arim.dazzleconf.engine.liaison.DoubleDefault
-
The double value to provide as a default.
- value() - Element in annotation type space.arim.dazzleconf.engine.liaison.FloatDefault
-
The float value to provide as a default.
- value() - Element in annotation type space.arim.dazzleconf.engine.liaison.IntegerDefault
-
The integer value to provide as a default
- value() - Element in annotation type space.arim.dazzleconf.engine.liaison.LongDefault
-
The long value to provide as a default.
- value() - Element in annotation type space.arim.dazzleconf.engine.liaison.ShortDefault
-
The short value to provide as a default.
- value() - Element in annotation type space.arim.dazzleconf.engine.liaison.StringDefault
-
The string value to provide as a default
- valueOf(String) - Static method in enum space.arim.dazzleconf.backend.KeyPath.SequenceBoundary
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum space.arim.dazzleconf.engine.CommentLocation
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum space.arim.dazzleconf.engine.UpdateReason
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum space.arim.dazzleconf.backend.KeyPath.SequenceBoundary
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum space.arim.dazzleconf.engine.CommentLocation
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum space.arim.dazzleconf.engine.UpdateReason
-
Returns an array containing the constants of this enum type, in the order they are declared.
- valuesFor(Class<?>) - Method in class space.arim.dazzleconf.reflect.MethodYield
-
Gets the yieldable values
W
- withComments(CommentData) - Method in class space.arim.dazzleconf.backend.DataEntry
-
Sets the comments and returns a new object
- withComments(CommentLocation, List<String>) - Method in class space.arim.dazzleconf.backend.DataEntry
-
Sets comments at the given location and returns a new object.
- withLineNumber(int) - Method in class space.arim.dazzleconf.backend.DataEntry
-
Sets the line number and returns a new object
- withOpaqueCache(MethodId.OpaqueCache) - Method in class space.arim.dazzleconf.reflect.MethodId
-
Creates a new method ID, with the argument set as the opaque cache.
- withValue(Object) - Method in class space.arim.dazzleconf.backend.DataEntry
-
Sets the value and returns a new object
- write(Backend.Document) - Method in interface space.arim.dazzleconf.backend.Backend
-
Writes the provided data tree to the source.
- writeEntryComments(CommentLocation) - Method in interface space.arim.dazzleconf.ConfigurationDefinition.ReadWithUpdateOptions
-
Controls whether comments on existing data entries are refreshed.
- writeEntryComments(CommentLocation) - Method in interface space.arim.dazzleconf.ConfigurationDefinition.WriteOptions
-
Controls whether comments are written to data entries.
- writeEntryComments(CommentLocation) - Method in interface space.arim.dazzleconf.engine.SerializeContext
-
Checks whether comments are being written on entries, and if so, where.
- writesFloatAsDouble() - Method in interface space.arim.dazzleconf.backend.Backend.Meta
-
Whether the backend writes
floatvalues by casting them todouble. - writeString(String) - Method in class space.arim.dazzleconf.backend.InputOutputRoot
- writeString(String) - Method in class space.arim.dazzleconf.backend.PathRoot
- writeString(String) - Method in interface space.arim.dazzleconf.backend.ReadableRoot
-
Writes to a string
- writeString(String) - Method in class space.arim.dazzleconf.backend.StringRoot
- writeTo(C, DataTree.Mut) - Method in interface space.arim.dazzleconf.Configuration
-
Writes to the given data tree.
- writeTo(C, DataTree.Mut, ConfigurationDefinition.WriteOptions) - Method in interface space.arim.dazzleconf.ConfigurationDefinition
-
Writes to the given data tree.
- wroteDefaults() - Method in interface space.arim.dazzleconf.ConfigureListener
-
Signals that the configuration didn't exist, so the whole thing was freshly written from default values.
All Classes and Interfaces|All Packages|Serialized Form
DeserializeInput.makeChild(DataEntry, Object). That method requires the caller to supply the child value's location, so to replicate this method's behavior, you would need to number your calls to this method and pass"$" + idxas the location.