Index

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

ABOVE - Enum constant in enum space.arim.dazzleconf2.engine.CommentLocation

Above the entry

Abstract() - Constructor for class space.arim.dazzleconf2.backend.Printable.Abstract

Creates

AbstractConfigurationFactory<C> - Class in space.arim.dazzleconf.factory

Deprecated.

Superseded by the much better designed HumanReadableConfigurationFactory

AbstractConfigurationFactory(Class<C>, ConfigurationOptions) - Constructor for class space.arim.dazzleconf.factory.AbstractConfigurationFactory

Deprecated.

Creates from a config class and config options

add(DataEntry) - Method in class space.arim.dazzleconf2.backend.DataList.Mut

Adds the given entry, expanding this list to accommodate

addBack(CharSequence) - Method in class space.arim.dazzleconf2.backend.KeyPath.Mut

Adds a key part at the back.

addDefaultTypeLiaisons() - Method in class space.arim.dazzleconf2.ConfigurationBuilder

Adds the default type liaisons to this builder.

addDetail(ErrorContext.Key<V>, V) - Method in interface space.arim.dazzleconf2.ErrorContext

Adds a piece of detail to this error context, overriding previous values.

addFilter(MigrateSource.Filter<C>) - Method in class space.arim.dazzleconf2.migration.MigrateFromConfiguration

addFilter(MigrateSource.Filter<C>) - Method in interface space.arim.dazzleconf2.migration.MigrateSource

Returns a new migration source, with the given filter applied.

addFront(CharSequence) - Method in class space.arim.dazzleconf2.backend.KeyPath.Mut

Adds a key part at the front.

addMigration(Migration<?, C>) - Method in class space.arim.dazzleconf2.ConfigurationBuilder

Adds the following migration to this builder.

addMigrations(List<Migration<?, C>>) - Method in class space.arim.dazzleconf2.ConfigurationBuilder

Adds the following migrations to this builder.

addPath(KeyPath.SequenceBoundary, KeyPath) - Method in class space.arim.dazzleconf2.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.dazzleconf2.ConfigurationBuilder

Adds type liaisons for primitives and String to this builder.

addSerialiser(ValueSerialiser<?>) - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder

Adds the specified value serialiser to this builder

addSerialisers(Collection<ValueSerialiser<?>>) - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder

Adds the specified value serialisers to this builder

addSerialisers(ValueSerialiser<?>...) - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder

Adds the specified value serialisers to this builder

addSimpleSerializer(TypeToken<V>, SerializeDeserialize<V>) - Method in class space.arim.dazzleconf2.ConfigurationBuilder

Adds a simple type liaison based on a single serializer.

addTypeLiaisons(List<TypeLiaison>) - Method in class space.arim.dazzleconf2.ConfigurationBuilder

Adds the following type liaisons to this builder.

addTypeLiaisons(TypeLiaison...) - Method in class space.arim.dazzleconf2.ConfigurationBuilder

Adds the following type liaisons to this builder.

addValidator(String, ValueValidator) - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder

Adds the specified value validator to this builder

addValidators(Map<String, ? extends ValueValidator>) - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder

Adds the specified value validators to this builder

allKeys() - Method in interface space.arim.dazzleconf2.ErrorContext

Gets all the keys set on this error context.

allKeysAreStrings() - Method in interface space.arim.dazzleconf2.backend.Backend.Meta

Whether the backend only recognizes string keys.

Annotated(Class<?>, ReifiedType.Annotated[], AnnotatedElement) - Constructor for class space.arim.dazzleconf2.reflect.ReifiedType.Annotated

Creates from nonnull input arguments

AnnotationBasedSorter - Class in space.arim.dazzleconf.sorter

Implementation of ConfigurationSorter to be paired with an annotation to sort entries

AnnotationBasedSorter() - Constructor for class space.arim.dazzleconf.sorter.AnnotationBasedSorter

AnnotationBasedSorter.Order - Annotation Type in space.arim.dazzleconf.sorter

Specifies the order of an entry per this sorter

append(CommentData) - Method in class space.arim.dazzleconf2.backend.CommentData

Appends another set of comments to this one.

appendAt(CommentLocation, String...) - Method in class space.arim.dazzleconf2.backend.CommentData

Appends comments at the following location and returns a new object.

appendAt(CommentLocation, List<String>) - Method in class space.arim.dazzleconf2.backend.CommentData

Appends comments at the following location and returns a new object.

applyKeyMapper(KeyMapper) - Method in class space.arim.dazzleconf2.backend.KeyPath.Mut

Applies a key mapper to existing key parts.

argumentAt(int) - Method in class space.arim.dazzleconf2.reflect.ReifiedType.Annotated

Gets the argument at a certain index

argumentAt(int) - Method in class space.arim.dazzleconf2.reflect.ReifiedType

Gets the argument at a certain index

argumentCount() - Method in class space.arim.dazzleconf2.reflect.ReifiedType

The argument count

arguments() - Method in class space.arim.dazzleconf2.reflect.ReifiedType.Annotated

Gets all the arguments

arguments() - Method in class space.arim.dazzleconf2.reflect.ReifiedType

Gets all the arguments

asMap() - Method in class space.arim.dazzleconf.serialiser.ValueSerialiserMap

Gets this value serialiser map as a Map.

AuxiliaryKeys - Interface in space.arim.dazzleconf

A marker interface for configurations produced by config factories where, although the config data was missing one or more keys, an auxiliary configuration instance was used to fill in the missing keys.

B

BACK - Enum constant in enum space.arim.dazzleconf2.backend.KeyPath.SequenceBoundary

Backend - Interface in space.arim.dazzleconf2.backend

Configuration backend for reading and writing data trees.

BACKEND_MESSAGE - Static variable in interface space.arim.dazzleconf2.ErrorContext

Error message provided by the configuration format backend

Backend.Document - Interface in space.arim.dazzleconf2.backend

A document loaded from, or writable to, a backend.

Backend.Meta - Interface in space.arim.dazzleconf2.backend

Defines metadata about a backend.

BadValueException - Exception Class in space.arim.dazzleconf.error

Indicates a value exists, but it itself violates some requirement

BadValueException.Builder - Class in space.arim.dazzleconf.error

Builder of BadValueException.

badValueExceptionBuilder() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Helper method to begin creating a BadValueException which describes this value.

BaseConfigurationFactory<C> - Class in space.arim.dazzleconf.factory

Deprecated.

Will be removed without replacement in a later release. Contributes little value on its own.

BaseConfigurationFactory(Class<C>, ConfigurationOptions) - Constructor for class space.arim.dazzleconf.factory.BaseConfigurationFactory

Deprecated.

Creates from a config class and config options

BELOW - Enum constant in enum space.arim.dazzleconf2.engine.CommentLocation

Below the entry

BinaryRoot - Interface in space.arim.dazzleconf2.backend

Data roots which are capable of working with raw bytes.

BooleanDefault - Annotation Type in space.arim.dazzleconf2.engine.liaison

Specifies the default value as a boolean.

BooleanLiaison - Class in space.arim.dazzleconf2.engine.liaison

Liaison for booleans

BooleanLiaison() - Constructor for class space.arim.dazzleconf2.engine.liaison.BooleanLiaison

Creates

build() - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder

Builds a ValidationOptions from the contents of this builder.

build() - Method in class space.arim.dazzleconf.error.BadValueException.Builder

build() - Method in class space.arim.dazzleconf2.ConfigurationBuilder

Builds into a fully fledged configuration.

Builder() - Constructor for class space.arim.dazzleconf.ConfigurationOptions.Builder

Creates the builder.

Builder() - Constructor for class space.arim.dazzleconf.error.BadValueException.Builder

buildError(Printable) - Method in interface space.arim.dazzleconf2.ErrorContext.Source

Builds an error context based on the implementation.

buildFrom(Comments[]) - Static method in class space.arim.dazzleconf2.backend.CommentData

Makes an instance of this class according to Comments annotations.

ByteDefault - Annotation Type in space.arim.dazzleconf2.engine.liaison

Specifies the default value as a byte.

ByteLiaison - Class in space.arim.dazzleconf2.engine.liaison

Liaison for bytes

ByteLiaison() - Constructor for class space.arim.dazzleconf2.engine.liaison.ByteLiaison

Creates

ByteRange - Annotation Type in space.arim.dazzleconf2.engine.liaison

Controls the range of a byte.

C

CallableFn - Annotation Type in space.arim.dazzleconf2.engine

Denotes a callable default method in a configuration interface.

callDefaultImpl(MethodId) - Method in class space.arim.dazzleconf2.reflect.MethodYield.ForImplementable

Specifies to invoke the default implementation.

cast(Object) - Method in class space.arim.dazzleconf2.reflect.TypeToken

Casts the argument to this type.

cause(Throwable) - Method in class space.arim.dazzleconf.error.BadValueException.Builder

chain(Transition<C_NEW, C_NEWER>) - Method in interface space.arim.dazzleconf2.migration.Transition

Chains on another transition after this one

CharacterLiaison - Class in space.arim.dazzleconf2.engine.liaison

Liaison for char and Character.

CharacterLiaison() - Constructor for class space.arim.dazzleconf2.engine.liaison.CharacterLiaison

Creates

charset() - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

Deprecated.

The charset used by this factory

charset() - Method in class space.arim.dazzleconf.factory.BaseConfigurationFactory

Deprecated.

The charset used by this factory

charset() - Method in class space.arim.dazzleconf.factory.HumanReadableConfigurationFactory

Gets the charset which will be used to create readers and writers

clear() - Method in class space.arim.dazzleconf2.backend.DataList.Mut

Clears all data

clear() - Method in class space.arim.dazzleconf2.backend.DataTree.Mut

Clears all data

clear() - Method in class space.arim.dazzleconf2.reflect.MethodYield

Clears all added values and starts over again

clearAt(CommentLocation...) - Method in class space.arim.dazzleconf2.backend.CommentData

Clears comments at some locations and returns a new object

clearDetail(ErrorContext.Key<?>) - Method in interface space.arim.dazzleconf2.ErrorContext

Clears the specified context for this error context

clearLineNumber() - Method in class space.arim.dazzleconf2.backend.DataEntry

Clears the line number and returns a new object

clearSerialisers() - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder

Clears the serialisers of this builder

clearTypeLiaisons() - Method in class space.arim.dazzleconf2.ConfigurationBuilder

Clears the type liaisons currently set on this builder

clearValidators() - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder

Clears the validators of this builder

close() - Method in class space.arim.dazzleconf2.reflect.MethodYield.ForImplementable

CollectionLiaison - Class in space.arim.dazzleconf2.engine.liaison

Liaison for lists, sets, and collections.

CollectionLiaison() - Constructor for class space.arim.dazzleconf2.engine.liaison.CollectionLiaison

Creates the liaison

CollectionSize - Annotation Type in space.arim.dazzleconf.annote

Applied to lists, sets, collections, and maps in order to limit their size

CommentData - Class in space.arim.dazzleconf2.backend

The comments on a data entry or configuration class.

CommentedWrapper - Class in space.arim.dazzleconf.factory

A simple wrapper used to attach comments to a configuration wrapper.

CommentedWrapper(List<String>, Object) - Constructor for class space.arim.dazzleconf.factory.CommentedWrapper

Creates from a list of comments and a value

CommentLocation - Enum in space.arim.dazzleconf2.engine

Where comments are located

comments() - Method in interface space.arim.dazzleconf2.backend.Backend.Document

The document-level comments.

Comments - Annotation Type in space.arim.dazzleconf2.engine

Adds comments to a configuration entry or type.

Comments.Container - Annotation Type in space.arim.dazzleconf2.engine

The repeatable annotations container for adding multiple comments.

compare(SortableConfigurationEntry, SortableConfigurationEntry) - Method in class space.arim.dazzleconf.sorter.AnnotationBasedSorter

ConfComments - Annotation Type in space.arim.dazzleconf.annote

Inserts one or more comments ahead of the config entry this annotation is placed before

ConfDefault - Class in space.arim.dazzleconf.annote

Container for annotations used to specify the default value on a config entry.

ConfDefault.DefaultBoolean - Annotation Type in space.arim.dazzleconf.annote

Specifies the default value as a boolean

ConfDefault.DefaultBooleans - Annotation Type in space.arim.dazzleconf.annote

Specifies the default value as a boolean array.

ConfDefault.DefaultDouble - Annotation Type in space.arim.dazzleconf.annote

Specifies the default value as a double.

ConfDefault.DefaultDoubles - Annotation Type in space.arim.dazzleconf.annote

Specifies the default value as a double array.

ConfDefault.DefaultInteger - Annotation Type in space.arim.dazzleconf.annote

Specifies the default value as an integer.

ConfDefault.DefaultIntegers - Annotation Type in space.arim.dazzleconf.annote

Specifies the default value as an integer array.

ConfDefault.DefaultLong - Annotation Type in space.arim.dazzleconf.annote

Specifies the default value as a long.

ConfDefault.DefaultLongs - Annotation Type in space.arim.dazzleconf.annote

Specifies the default value as a long array.

ConfDefault.DefaultMap - Annotation Type in space.arim.dazzleconf.annote

Specifies the default value as a map.

ConfDefault.DefaultObject - Annotation Type in space.arim.dazzleconf.annote

Specifies the qualified name of the static method returning the default value.

ConfDefault.DefaultString - Annotation Type in space.arim.dazzleconf.annote

Specifies the default value as string.

ConfDefault.DefaultStrings - Annotation Type in space.arim.dazzleconf.annote

Specifies the default value as a string array.

ConfHeader - Annotation Type in space.arim.dazzleconf.annote

Allows specifying the comment header on a top level configuration or a comment on a sub section.

ConfigFormatSyntaxException - Exception Class in space.arim.dazzleconf.error

Indicates the syntax of a specific config format is invalid

ConfigFormatSyntaxException() - Constructor for exception class space.arim.dazzleconf.error.ConfigFormatSyntaxException

Creates the exception

ConfigFormatSyntaxException(String) - Constructor for exception class space.arim.dazzleconf.error.ConfigFormatSyntaxException

Creates the exception with an exception message

ConfigFormatSyntaxException(String, Throwable) - Constructor for exception class space.arim.dazzleconf.error.ConfigFormatSyntaxException

Creates the exception with an exception message and cause

ConfigFormatSyntaxException(Throwable) - Constructor for exception class space.arim.dazzleconf.error.ConfigFormatSyntaxException

Creates the exception with a cause

Configuration<C> - Interface in space.arim.dazzleconf2

Main interface.

ConfigurationBuilder<C> - Class in space.arim.dazzleconf2

A builder for Configuration.

ConfigurationBuilder(TypeToken<C>) - Constructor for class space.arim.dazzleconf2.ConfigurationBuilder

Creates for the specified interface type.

ConfigurationDefinition<C> - Interface in space.arim.dazzleconf2

Provides the minimal methods for reading and writing configurations from data trees

ConfigurationDefinition.Layout - Interface in space.arim.dazzleconf2

The layout of a configuration definition.

ConfigurationDefinition.ReadOptions - Interface in space.arim.dazzleconf2

Parameters for reading a configuration from a tree

ConfigurationDefinition.ReadWithUpdateOptions - Interface in space.arim.dazzleconf2

Parameters for reading a configuration and updating it in-place

ConfigurationDefinition.WriteOptions - Interface in space.arim.dazzleconf2

Parameters for writing a configuration to a tree

ConfigurationFactory<C> - Interface in space.arim.dazzleconf

Loader and writer of configuration data

ConfigurationFormatFactory<C> - Class in space.arim.dazzleconf.factory

Abstract implementation of ConfigurationFactory which takes care of configuration loading from a map.

ConfigurationFormatFactory(Class<C>, ConfigurationOptions) - Constructor for class space.arim.dazzleconf.factory.ConfigurationFormatFactory

Creates from a config class and config options

ConfigurationHelper<C> - Class in space.arim.dazzleconf.helper

Simple helper class designed to assist in reloading a configuration

ConfigurationHelper(Path, String, ConfigurationFactory<C>) - Constructor for class space.arim.dazzleconf.helper.ConfigurationHelper

Creates from an enclosing directory, filename within that directory, and ConfigurationFactory.

ConfigurationOptions - Class in space.arim.dazzleconf

Options for loading, validating, and writing configuration values

ConfigurationOptions.Builder - Class in space.arim.dazzleconf

Builder of ConfigurationOptions.

ConfigurationSorter - Interface in space.arim.dazzleconf.sorter

Sorter of configuration entries, so that when the configuration is written to a stream or channel, it may be done so in the desired order.

ConfigureListener - Interface in space.arim.dazzleconf2

Listener that lets the implementor know about various configuration events

configureOrFallback(Backend, ConfigureListener, ErrorPrint) - Method in interface space.arim.dazzleconf2.Configuration

Configures, migrates, and/or updates the backend as needed.

configureOrFallback(Backend, ErrorPrint) - Method in interface space.arim.dazzleconf2.Configuration

Configures, migrates, and/or updates the backend as needed.

configureWith(Backend) - Method in interface space.arim.dazzleconf2.Configuration

Configures, migrates, and/or updates the backend as needed.

configureWith(Backend, ConfigureListener) - Method in interface space.arim.dazzleconf2.Configuration

Configures, migrates, and/or updates the backend as needed.

ConfKey - Annotation Type in space.arim.dazzleconf.annote

Specifies the key whose value will be used for this method.

ConfSerialisers - Annotation Type in space.arim.dazzleconf.annote

Attaches a value serialiser to a configuration interface

ConfValidator - Annotation Type in space.arim.dazzleconf.annote

Attaches a value validator to a config entry

copy() - Method in class space.arim.dazzleconf2.reflect.MethodYield

Returns a deep copy of this method yield's contents.

copyDetailsInto(ErrorContext) - Method in interface space.arim.dazzleconf2.ErrorContext

Copies all context details from this error context into another one

copyFrom(DataTree) - Method in class space.arim.dazzleconf2.backend.DataTree.Mut

Merges all data in the specified data tree into this one, merging nested sections.

createSingleElementCollections() - Method in class space.arim.dazzleconf.ConfigurationOptions

Whether single element collections are created for config values which were not originally collections

D

data() - Method in interface space.arim.dazzleconf2.backend.Backend.Document

The data itself, in the form of a navigable tree

DataEntry - Class in space.arim.dazzleconf2.backend

A data value, with associated metadata as interoperable with backend formats.

DataEntry(Object) - Constructor for class space.arim.dazzleconf2.backend.DataEntry

Creates from a nonnull value.

dataExists() - Method in interface space.arim.dazzleconf2.backend.DataRoot

Checks whether the data is known to exist.

dataExists() - Method in class space.arim.dazzleconf2.backend.PathRoot

dataExists() - Method in class space.arim.dazzleconf2.backend.StringRoot

DataList - Class in space.arim.dazzleconf2.backend

A list of in-memory configuration data.

DataList() - Constructor for class space.arim.dazzleconf2.backend.DataList

DataList.Immut - Class in space.arim.dazzleconf2.backend

A data list which is immutable.

DataList.Mut - Class in space.arim.dazzleconf2.backend

A data list which can be modified.

DataRoot - Interface in space.arim.dazzleconf2.backend

The root source of configuration data.

DataRoot.Operation<R,U> - Interface in space.arim.dazzleconf2.backend

IO proof, functional interface for use with reader/writer methods

DataTree - Class in space.arim.dazzleconf2.backend

A tree of in-memory configuration data.

DataTree.Immut - Class in space.arim.dazzleconf2.backend

A data tree which is immutable.

DataTree.Mut - Class in space.arim.dazzleconf2.backend

A data tree which can be modified.

decompose(Class<T>, T) - Method in interface space.arim.dazzleconf.serialiser.Decomposer

Decomposes an object of a certain type, using a value serializer if necessary.

decomposeCollection(Class<E>, Collection<? extends E>) - Method in interface space.arim.dazzleconf.serialiser.Decomposer

Decomposes all the elements of a collection.

decomposeMap(Class<K>, Class<V>, Map<? extends K, ? extends V>) - Method in interface space.arim.dazzleconf.serialiser.Decomposer

Decomposes all the keys and values of a map.

Decomposer - Interface in space.arim.dazzleconf.serialiser

A complement to FlexibleType which allows objects to be broken down during reserialisation.

defaultBuilder(Class<C>) - Static method in interface space.arim.dazzleconf2.Configuration

Convenience method for building a configuration.

defaultBuilder(TypeToken<C>) - Static method in interface space.arim.dazzleconf2.Configuration

Convenience method for building a configuration that adds the default type liaisons.

DefaultKeyMapper - Class in space.arim.dazzleconf2.backend

Default, "no-op" mapper for keys and method names

DefaultKeyMapper() - Constructor for class space.arim.dazzleconf2.backend.DefaultKeyMapper

Creates

DefaultReflectionService - Class in space.arim.dazzleconf2.reflect

The default implementation of ReflectionService.

DefaultReflectionService() - Constructor for class space.arim.dazzleconf2.reflect.DefaultReflectionService

Creates the service

defaults() - Static method in class space.arim.dazzleconf.ConfigurationOptions

Returns the default configuration options

defaultValue() - Method in interface space.arim.dazzleconf2.engine.DefaultValues

Gets the default value

DefaultValues<V> - Interface in space.arim.dazzleconf2.engine

Storage for default values

deserialise(FlexibleType) - Method in class space.arim.dazzleconf.serialiser.URLValueSerialiser

deserialise(FlexibleType) - Method in interface space.arim.dazzleconf.serialiser.ValueSerialiser

Deserializes a value from a flexible type representing a raw config value.

deserialize(DeserializeInput) - Method in interface space.arim.dazzleconf2.engine.SerializeDeserialize

Deserializes using the given operable object.

DeserializeContext - Interface in space.arim.dazzleconf2.engine

A context for deserialization.

DeserializeInput - Interface in space.arim.dazzleconf2.engine

An object from a data tree, that is being processed for deserialization.

deserializeUpdate(DeserializeInput, SerializeOutput) - Method in interface space.arim.dazzleconf2.engine.SerializeDeserialize

Deserializes using the given operable object, and updates the input value if needed.

DeveloperMistakeException - Exception Class in space.arim.dazzleconf2

Thrown whenever a preventable problem in how the configuration was constructed or defined arises at runtime.

DeveloperMistakeException(String) - Constructor for exception class space.arim.dazzleconf2.DeveloperMistakeException

Creates from the given message

DeveloperMistakeException(String, Throwable) - Constructor for exception class space.arim.dazzleconf2.DeveloperMistakeException

Creates from a message and cause

display() - Method in interface space.arim.dazzleconf2.ErrorContext

Formats this error context and includes all information.

DoubleDefault - Annotation Type in space.arim.dazzleconf2.engine.liaison

Specifies the default value as a double

DoubleLiaison - Class in space.arim.dazzleconf2.engine.liaison

Liaison for doubles

DoubleLiaison() - Constructor for class space.arim.dazzleconf2.engine.liaison.DoubleLiaison

Creates

DoubleRange - Annotation Type in space.arim.dazzleconf2.engine.liaison

Controls the range of a double.

E

empty() - Static method in class space.arim.dazzleconf.serialiser.ValueSerialiserMap

Gets an empty value serialiser map

empty() - Static method in class space.arim.dazzleconf2.backend.CommentData

Returns an empty instance of Comments

empty() - Static method in class space.arim.dazzleconf2.backend.KeyPath

Returns an empty key path.

EMPTY_ARRAY - Static variable in class space.arim.dazzleconf2.reflect.ReifiedType.Annotated

A reusable empty array for this type

enclosingType() - Method in interface space.arim.dazzleconf2.engine.TypeLiaison.DefaultInit

The interface type where the method is located, after computing inheritance.

entries() - Method in class space.arim.dazzleconf2.reflect.MethodYield

Gets all entries added.

entry() - Method in interface space.arim.dazzleconf2.engine.DeserializeInput

The entry of the object being deserialized.

ENTRY_PATH - Static variable in interface space.arim.dazzleconf2.ErrorContext

Path of the configuration entry being scanned or operated upon

EnumLiaison - Class in space.arim.dazzleconf2.engine.liaison

A liaison for enum types.

EnumLiaison() - Constructor for class space.arim.dazzleconf2.engine.liaison.EnumLiaison

Creates

equals(Object) - Method in class space.arim.dazzleconf.ConfigurationOptions

equals(Object) - Method in class space.arim.dazzleconf.factory.CommentedWrapper

equals(Object) - Method in class space.arim.dazzleconf.serialiser.ValueSerialiserMap

equals(Object) - Method in class space.arim.dazzleconf2.backend.CommentData

equals(Object) - Method in class space.arim.dazzleconf2.backend.DataEntry

equals(Object) - Method in class space.arim.dazzleconf2.backend.DataList

equals(Object) - Method in class space.arim.dazzleconf2.backend.DataTree

equals(Object) - Method in class space.arim.dazzleconf2.backend.KeyPath

equals(Object) - Method in class space.arim.dazzleconf2.LoadResult

equals(Object) - Method in class space.arim.dazzleconf2.reflect.InvokeDefaultFunction

equals(Object) - Method in class space.arim.dazzleconf2.reflect.MethodId

equals(Object) - Method in class space.arim.dazzleconf2.reflect.MethodYield

equals(Object) - Method in class space.arim.dazzleconf2.reflect.ReifiedType

equals(Object) - Method in class space.arim.dazzleconf2.reflect.TypeToken

A type token is equal to another when it points to the same reified type (at runtime)

ErrorContext - Interface in space.arim.dazzleconf2

Context holder for errors in LoadResult.

ErrorContext.Key<V> - Class in space.arim.dazzleconf2

A marker for context keys

ErrorContext.Source - Interface in space.arim.dazzleconf2

A source of error contexts.

ErrorPrint - Interface in space.arim.dazzleconf2

Output device for when an error occured

ErrorPrint.Output - Interface in space.arim.dazzleconf2

The message sink (used by some ErrorPrint implementations) where printable messages are sent

errorSource() - Method in interface space.arim.dazzleconf2.migration.MigrateContext

A factory allowing migrations to produce errors.

F

failure(List<ErrorContext>) - Static method in class space.arim.dazzleconf2.LoadResult

Creates a failed load result with the given error contexts

failure(ErrorContext...) - Static method in class space.arim.dazzleconf2.LoadResult

Creates a failed load result with the given error contexts

flatMap(Function<? super R, ? extends LoadResult<R_NEW>>) - Method in class space.arim.dazzleconf2.LoadResult

Maps from one load result to another.

FlexibleType - Interface in space.arim.dazzleconf.serialiser

A type which may be adapted to some other.

FlexibleTypeFunction<T> - Interface in space.arim.dazzleconf.serialiser

Functional interface which computes a result from a FlexibleType

FlexibleTypeMapEntryFunction<K,V> - Interface in space.arim.dazzleconf.serialiser

Functional interface which computes a

FloatDefault - Annotation Type in space.arim.dazzleconf2.engine.liaison

Specifies the default value as a float

FloatLiaison - Class in space.arim.dazzleconf2.engine.liaison

Liaison for floats

FloatLiaison() - Constructor for class space.arim.dazzleconf2.engine.liaison.FloatLiaison

Creates

FloatRange - Annotation Type in space.arim.dazzleconf2.engine.liaison

Controls the range of a double.

forEach(Consumer<? super CharSequence>) - Method in class space.arim.dazzleconf2.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.dazzleconf2.backend.DataTree

Runs an action for each key/value pair.

forEach(BiConsumer<? super Object, ? super DataEntry>) - Method in class space.arim.dazzleconf2.backend.DataTree.Immut

forEach(BiConsumer<? super Object, ? super DataEntry>) - Method in class space.arim.dazzleconf2.backend.DataTree.Mut

forEach(Consumer<? super DataEntry>) - Method in class space.arim.dazzleconf2.backend.DataList

Runs an action for each element.

forEach(Consumer<? super DataEntry>) - Method in class space.arim.dazzleconf2.backend.DataList.Immut

forEach(Consumer<? super DataEntry>) - Method in class space.arim.dazzleconf2.backend.DataList.Mut

forImplementable(Class<?>) - Method in class space.arim.dazzleconf2.reflect.MethodYield

Begins adding yield values for the given interface.

ForImplementable() - Constructor for class space.arim.dazzleconf2.reflect.MethodYield.ForImplementable

forKey(String) - Static method in exception class space.arim.dazzleconf.error.MissingKeyException

Creates the exception using the given key

forKey(String) - Static method in exception class space.arim.dazzleconf.error.MissingValueException

Creates the exception using the given key

forKeyAndMessage(String, CharSequence) - Static method in exception class space.arim.dazzleconf.error.MissingKeyException

Creates the exception with the given key and message

forKeyAndMessage(String, CharSequence) - Static method in exception class space.arim.dazzleconf.error.MissingValueException

Creates the exception with the given key and message

forKeyAndMessage(String, String) - Static method in exception class space.arim.dazzleconf.error.MissingKeyException

Creates the exception with the given key and message

forKeyAndMessage(String, String) - Static method in exception class space.arim.dazzleconf.error.MissingValueException

Creates the exception with the given key and message

FRONT - Enum constant in enum space.arim.dazzleconf2.backend.KeyPath.SequenceBoundary

G

generate(Class<I>, MethodYield) - Method in interface space.arim.dazzleconf2.reflect.Instantiator

Generates the target class.

generateEmpty(Class<I>) - Method in interface space.arim.dazzleconf2.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.dazzleconf2.reflect.Instantiator

Makes a reloadable shell for the given interface type.

get(int) - Method in class space.arim.dazzleconf2.backend.DataList

Gets the entry at the specified index.

get(int) - Method in class space.arim.dazzleconf2.backend.DataList.Immut

get(int) - Method in class space.arim.dazzleconf2.backend.DataList.Mut

get(Object) - Method in class space.arim.dazzleconf2.backend.DataTree

Gets the entry at the specified key, or null if unset.

get(Object) - Method in class space.arim.dazzleconf2.backend.DataTree.Immut

get(Object) - Method in class space.arim.dazzleconf2.backend.DataTree.Mut

getAndClearLastOutput() - Method in interface space.arim.dazzleconf2.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.dazzleconf2.reflect.ReifiedType.Annotated

getAnnotations() - Method in class space.arim.dazzleconf2.reflect.ReifiedType.Annotated

getAnnotations(MethodId) - Method in interface space.arim.dazzleconf2.reflect.MethodMirror.TypeWalker

Gets annotations present on the specified method.

getAnnotationsByType(Class<T>) - Method in class space.arim.dazzleconf2.reflect.ReifiedType.Annotated

getAssociatedKey() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the key associated with this flexible type.

getAt(CommentLocation) - Method in class space.arim.dazzleconf2.backend.CommentData

Gets the comments at the specified location.

getBoolean() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a boolean

getByte() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a byte

getCharacter() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a character

getCollection() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a collection of further flexible types.

getCollection(FlexibleTypeFunction<? extends E>) - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a collection of further flexible types (FlexibleType.getCollection()) and processes it by converting each flexible type element to a result element.

getComments() - Method in class space.arim.dazzleconf.factory.CommentedWrapper

Gets the comments, which come before the value

getComments() - Method in interface space.arim.dazzleconf.sorter.SortableConfigurationEntry

Gets an immutable list of the comments on this entry

getComments() - Method in class space.arim.dazzleconf2.backend.DataEntry

Gets the comments present

getComments() - Method in interface space.arim.dazzleconf2.ConfigurationDefinition.Layout

Gets the top level comments on the configuration interface.

getComments(CommentLocation) - Method in class space.arim.dazzleconf2.backend.DataEntry

Gets the comments present on this entry at the specified location.

getConfigClass() - Method in interface space.arim.dazzleconf.ConfigurationFactory

Gets the configuration class this factory is for

getConfigClass() - Method in class space.arim.dazzleconf.factory.BaseConfigurationFactory

Deprecated.

getConfigClass() - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

getConfigClass() - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

getConfiguration(TypeToken<U>) - Method in interface space.arim.dazzleconf2.engine.TypeLiaison.Handshake

Gets another configuration.

getConfigurationSorter() - Method in class space.arim.dazzleconf.ConfigurationOptions

Gets the configuration sorter

getCurrentDelegate() - Method in interface space.arim.dazzleconf2.ReloadShell

Gets the current inner delegate

getDeclaredAnnotation(Class<T>) - Method in class space.arim.dazzleconf2.reflect.ReifiedType.Annotated

getDeclaredAnnotations() - Method in class space.arim.dazzleconf2.reflect.ReifiedType.Annotated

getDeclaredAnnotationsByType(Class<T>) - Method in class space.arim.dazzleconf2.reflect.ReifiedType.Annotated

getDouble() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a double

getEnclosingType() - Method in interface space.arim.dazzleconf2.reflect.MethodMirror.TypeWalker

Gets the type which this TypeWalker is looking at

getEnum(Class<T>) - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as an enum type

getErrorContexts() - Method in class space.arim.dazzleconf2.LoadResult

Gets the error contexts.

getFactory() - Method in class space.arim.dazzleconf.helper.ConfigurationHelper

Gets the configuration factory

getFloat() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a float

getHeader() - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

Deprecated.

Gets the comment header on the top level configuration

getHeader() - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

Gets the comment header on the top level configuration.

getInstance() - Static method in class space.arim.dazzleconf.serialiser.URLValueSerialiser

getInstantiator() - Method in interface space.arim.dazzleconf2.ConfigurationDefinition.Layout

Gets the instantiator used to generate interface implementations.

getInteger() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as an integer

getKey() - Method in exception class space.arim.dazzleconf.error.ImproperEntryException

Gets the key which this exception applies to

getKey() - Method in interface space.arim.dazzleconf.sorter.SortableConfigurationEntry

Gets the config key for this entry.

getKeyMapper() - Method in interface space.arim.dazzleconf2.Configuration

Gets the key mapper if one was specified during construction.

getLayout() - Method in interface space.arim.dazzleconf2.ConfigurationDefinition

Gets the layout of the configuration interface

getLeading(KeyPath.SequenceBoundary) - Method in class space.arim.dazzleconf2.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 (if SequenceBoundary.BACK).

getLineNumber() - Method in class space.arim.dazzleconf2.backend.DataEntry

Gets the line number if present

getList() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a list of further flexible types.

getList(FlexibleTypeFunction<? extends E>) - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a list of further flexible types (FlexibleType.getList()) and processes it by converting each flexible type element to a result element.

getLocale() - Method in interface space.arim.dazzleconf2.Configuration

Gets the locale used at the library level.

getLocale() - Method in interface space.arim.dazzleconf2.ErrorContext

The locale to format messages in.

getLocale() - Method in interface space.arim.dazzleconf2.ErrorContext.Source

The locale to format error messages in.

getLong() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a long

getMap() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a map of further flexible types.

getMap(FlexibleTypeMapEntryFunction<? extends K, ? extends V>) - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a map of further flexible types (FlexibleType.getMap()) and processes it by converting each pair of flexible types to a map entry.

getMethod() - Method in interface space.arim.dazzleconf.sorter.SortableConfigurationEntry

Gets the raw method corresponding to this entry

getMethodMirror() - Method in interface space.arim.dazzleconf2.ConfigurationDefinition.Layout

Gets the method mirror used to invoke methods

getMigrations() - Method in interface space.arim.dazzleconf2.Configuration

Gets the migrations.

getObject(Class<T>) - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets this type as some arbitrary object.

getOpaqueCache() - Method in class space.arim.dazzleconf2.reflect.MethodId

Gets the opaque cache attached to this method ID, if one exists.

getOptions() - Method in interface space.arim.dazzleconf.ConfigurationFactory

Gets the configuration options this factory uses

getOptions() - Method in class space.arim.dazzleconf.factory.BaseConfigurationFactory

Deprecated.

getOptions() - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

getOptions() - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

getOrThrow() - Method in class space.arim.dazzleconf2.LoadResult

Unwraps the success value or throws an exception.

getOtherSerializer(TypeToken<U>) - Method in interface space.arim.dazzleconf2.engine.TypeLiaison.Handshake

Gets another serializer.

getRawType() - Method in class space.arim.dazzleconf2.reflect.TypeToken

Gets the raw type as a class object

getReifiedType() - Method in interface space.arim.dazzleconf2.ConfigurationDefinition.Layout

Gets the type of the configuration interface.

getReifiedType() - Method in class space.arim.dazzleconf2.reflect.TypeToken

Gets the annotated reified type represented by this type token

getResult(FlexibleType) - Method in interface space.arim.dazzleconf.serialiser.FlexibleTypeFunction

Gets a result from the flexible type

getResult(FlexibleType, FlexibleType) - Method in interface space.arim.dazzleconf.serialiser.FlexibleTypeMapEntryFunction

Gets a result from two flexible types

getSerialiser(Class<T>) - Method in class space.arim.dazzleconf.serialiser.ValueSerialiserMap

Deprecated.

Use ValueSerialiserMap.getSerialiserFor(Class) instead

getSerialiserFor(Class<T>) - Method in class space.arim.dazzleconf.serialiser.ValueSerialiserMap

Gets the value serialiser for a given type

getSerialisers() - Method in class space.arim.dazzleconf.ConfigurationOptions

Gets the configuration value serialisers.

getSet() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a set of further flexible types.

getSet(FlexibleTypeFunction<? extends E>) - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a set of further flexible types (FlexibleType.getSet()) and processes it by converting each flexible type element to a result element.

getShell() - Method in interface space.arim.dazzleconf2.ReloadShell

Gets the configuration shell, a proxy to the current delegate.

getShort() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a short

getSorter() - Method in class space.arim.dazzleconf.ConfigurationOptions

Deprecated.

Use ConfigurationOptions.getConfigurationSorter() instead

getString() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType

Gets the value as a string

getSuperTypes() - Method in interface space.arim.dazzleconf2.reflect.MethodMirror.TypeWalker

Moves to the directly declared super types of this type

getTargetClass() - Method in class space.arim.dazzleconf.serialiser.URLValueSerialiser

getTargetClass() - Method in interface space.arim.dazzleconf.serialiser.ValueSerialiser

Gets the target type of deserialization

getType() - Method in interface space.arim.dazzleconf2.ConfigurationDefinition

Gets the reified type of the configuration interface

getTypeLiaisons() - Method in interface space.arim.dazzleconf2.Configuration

Gets all type liaisons.

getValidators() - Method in class space.arim.dazzleconf.ConfigurationOptions

Gets an immutable map of value validators, keyed by the configuration key to which they apply.

getValue() - Method in class space.arim.dazzleconf.factory.CommentedWrapper

Gets the config value

getValue() - Method in class space.arim.dazzleconf2.backend.DataEntry

Gets the value.

getValue() - Method in class space.arim.dazzleconf2.LoadResult

Tries to get at the success value.

getViableMethods() - Method in interface space.arim.dazzleconf2.reflect.MethodMirror.TypeWalker

Gets all accessible, non-inherited, instance methods declared in this type.

H

handlesBuffering() - Method in interface space.arim.dazzleconf2.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.ConfigurationOptions

hashCode() - Method in class space.arim.dazzleconf.factory.CommentedWrapper

hashCode() - Method in class space.arim.dazzleconf.serialiser.ValueSerialiserMap

hashCode() - Method in class space.arim.dazzleconf2.backend.CommentData

hashCode() - Method in class space.arim.dazzleconf2.backend.DataEntry

hashCode() - Method in class space.arim.dazzleconf2.backend.DataList

hashCode() - Method in class space.arim.dazzleconf2.backend.DataTree

hashCode() - Method in class space.arim.dazzleconf2.backend.KeyPath

hashCode() - Method in class space.arim.dazzleconf2.LoadResult

hashCode() - Method in class space.arim.dazzleconf2.reflect.InvokeDefaultFunction

hashCode() - Method in class space.arim.dazzleconf2.reflect.MethodId

hashCode() - Method in class space.arim.dazzleconf2.reflect.MethodYield

hashCode() - Method in class space.arim.dazzleconf2.reflect.ReifiedType

hashCode() - Method in class space.arim.dazzleconf2.reflect.TypeToken

hasProduced(Object) - Method in interface space.arim.dazzleconf2.reflect.Instantiator

Checks whether this instantiator produced the specified object.

HumanReadableConfigurationFactory<C> - Class in space.arim.dazzleconf.factory

Extension of ConfigurationFormatFactory which turns ReadableByteChannel and InputStream into Reader and WritableByteChannel and OutputStream into Writer.

HumanReadableConfigurationFactory(Class<C>, ConfigurationOptions) - Constructor for class space.arim.dazzleconf.factory.HumanReadableConfigurationFactory

Creates from a config class and config options

I

ifMissing() - Method in interface space.arim.dazzleconf2.engine.DefaultValues

Gets the value if missing in an existing configuration

ifMissing() - Element in annotation type space.arim.dazzleconf2.engine.liaison.BooleanDefault

The boolean value to provide as an "if missing" default.

ifMissing() - Element in annotation type space.arim.dazzleconf2.engine.liaison.ByteDefault

The byte value to provide as an "if missing" default.

ifMissing() - Element in annotation type space.arim.dazzleconf2.engine.liaison.DoubleDefault

The double value to provide as an "if missing" default.

ifMissing() - Element in annotation type space.arim.dazzleconf2.engine.liaison.FloatDefault

The float value to provide as an "if missing" default.

ifMissing() - Element in annotation type space.arim.dazzleconf2.engine.liaison.IntegerDefault

The int value to provide as an "if missing" default.

ifMissing() - Element in annotation type space.arim.dazzleconf2.engine.liaison.LongDefault

The long value to provide as an "if missing" default.

ifMissing() - Element in annotation type space.arim.dazzleconf2.engine.liaison.ShortDefault

The short value to provide as an "if missing" default.

ifMissing() - Element in annotation type space.arim.dazzleconf2.engine.liaison.StringDefault

The string value to provide as an "if missing" default.

ifSuccess(Consumer<? super R>) - Method in class space.arim.dazzleconf2.LoadResult

Runs an action on the success value.

IllDefinedConfigException - Exception Class in space.arim.dazzleconf.error

Indicates the programmer creating the configuration has made a mistake, such as violating an annotation contract.

IllDefinedConfigException() - Constructor for exception class space.arim.dazzleconf.error.IllDefinedConfigException

Creates the exception

IllDefinedConfigException(String) - Constructor for exception class space.arim.dazzleconf.error.IllDefinedConfigException

Creates the exception with an exception message

IllDefinedConfigException(String, Throwable) - Constructor for exception class space.arim.dazzleconf.error.IllDefinedConfigException

Creates the exception with an exception message and cause

IllDefinedConfigException(Throwable) - Constructor for exception class space.arim.dazzleconf.error.IllDefinedConfigException

Creates the exception with a cause

Immut() - Constructor for class space.arim.dazzleconf2.backend.DataList.Immut

Creates an empty data list

Immut() - Constructor for class space.arim.dazzleconf2.backend.DataTree.Immut

Creates an empty data tree

Immut() - Constructor for class space.arim.dazzleconf2.backend.KeyPath.Immut

Creates an empty key path

Immut(String...) - Constructor for class space.arim.dazzleconf2.backend.KeyPath.Immut

Creates from the given parts

Immut(Collection<DataEntry>) - Constructor for class space.arim.dazzleconf2.backend.DataList.Immut

Creates from the given elements.

Immut(DataEntry...) - Constructor for class space.arim.dazzleconf2.backend.DataList.Immut

Creates from the given elements.

Immut(KeyPath) - Constructor for class space.arim.dazzleconf2.backend.KeyPath.Immut

Creates from another key path.

implementable() - Method in class space.arim.dazzleconf2.reflect.MethodYield.Entry

Gets the interface being implemented

ImproperEntryException - Exception Class in space.arim.dazzleconf.error

General exception indicating a problem with a specific configuration entry

INLINE - Enum constant in enum space.arim.dazzleconf2.engine.CommentLocation

Inline to the entry.

InputOutputRoot - Class in space.arim.dazzleconf2.backend

A base class for data root that makes use of InputStream and OutputStream.

InputOutputRoot(Charset) - Constructor for class space.arim.dazzleconf2.backend.InputOutputRoot

Sets the charset to use for read/write operations involving textual streams

Instantiator - Interface in space.arim.dazzleconf2.reflect

Service capable of generating runtime implementations of interfaces.

IntegerDefault - Annotation Type in space.arim.dazzleconf2.engine.liaison

Specifies the default value as an integer.

IntegerLiaison - Class in space.arim.dazzleconf2.engine.liaison

Liaison for integers

IntegerLiaison() - Constructor for class space.arim.dazzleconf2.engine.liaison.IntegerLiaison

Creates

IntegerRange - Annotation Type in space.arim.dazzleconf.annote

Controls the range of an numeric type.

IntegerRange - Annotation Type in space.arim.dazzleconf2.engine.liaison

Controls the range of an int.

intoImmut() - Method in class space.arim.dazzleconf2.backend.DataList.Immut

intoImmut() - Method in class space.arim.dazzleconf2.backend.DataList

Gets this data tree as an immutable one.

intoImmut() - Method in class space.arim.dazzleconf2.backend.DataList.Mut

intoImmut() - Method in class space.arim.dazzleconf2.backend.DataTree.Immut

intoImmut() - Method in class space.arim.dazzleconf2.backend.DataTree

Gets this data tree as an immutable one.

intoImmut() - Method in class space.arim.dazzleconf2.backend.DataTree.Mut

intoImmut() - Method in class space.arim.dazzleconf2.backend.KeyPath.Immut

intoImmut() - Method in class space.arim.dazzleconf2.backend.KeyPath

Gets this key path as an immutable one.

intoImmut() - Method in class space.arim.dazzleconf2.backend.KeyPath.Mut

intoMut() - Method in class space.arim.dazzleconf2.backend.DataList.Immut

intoMut() - Method in class space.arim.dazzleconf2.backend.DataList

Gets this data list as a mutable one.

intoMut() - Method in class space.arim.dazzleconf2.backend.DataList.Mut

intoMut() - Method in class space.arim.dazzleconf2.backend.DataTree.Immut

intoMut() - Method in class space.arim.dazzleconf2.backend.DataTree

Gets this data tree as a mutable one.

intoMut() - Method in class space.arim.dazzleconf2.backend.DataTree.Mut

intoMut() - Method in class space.arim.dazzleconf2.backend.KeyPath.Immut

intoMut() - Method in class space.arim.dazzleconf2.backend.KeyPath

Gets this key path as a mutable one.

intoMut() - Method in class space.arim.dazzleconf2.backend.KeyPath.Mut

intoParts() - Method in class space.arim.dazzleconf2.backend.KeyPath

Turns into key path parts.

intoPartsList() - Method in class space.arim.dazzleconf2.backend.KeyPath

Same as KeyPath.intoParts() but returns a list.

InvalidConfigException - Exception Class in space.arim.dazzleconf.error

Thrown to indicate an invalid configuration

InvalidConfigException() - Constructor for exception class space.arim.dazzleconf.error.InvalidConfigException

Creates the exception

InvalidConfigException(String) - Constructor for exception class space.arim.dazzleconf.error.InvalidConfigException

Creates the exception with an exception message

InvalidConfigException(String, Throwable) - Constructor for exception class space.arim.dazzleconf.error.InvalidConfigException

Creates the exception with an exception message and cause

InvalidConfigException(Throwable) - Constructor for exception class space.arim.dazzleconf.error.InvalidConfigException

Creates the exception with a cause

InvokeDefaultFunction - Class in space.arim.dazzleconf2.reflect

A marker value used for MethodYield that instructs the Instantiator to call the default method.

InvokeDefaultFunction() - Constructor for class space.arim.dazzleconf2.reflect.InvokeDefaultFunction

Creates

invokeMethod(MethodId, Object...) - Method in interface space.arim.dazzleconf2.reflect.MethodMirror.Invoker

Invokes a method and gets the return value.

isAnnotationPresent(Class<? extends Annotation>) - Method in class space.arim.dazzleconf2.reflect.ReifiedType.Annotated

isDefault() - Method in class space.arim.dazzleconf2.reflect.MethodId

Gets whether the method is implemented by default

isEmpty() - Method in class space.arim.dazzleconf2.backend.CommentData

Gets whether there are no comments

isEmpty() - Method in class space.arim.dazzleconf2.backend.DataList.Immut

isEmpty() - Method in class space.arim.dazzleconf2.backend.DataList

Whether this data list is devoid of elements

isEmpty() - Method in class space.arim.dazzleconf2.backend.DataList.Mut

isEmpty() - Method in class space.arim.dazzleconf2.backend.DataTree

Whether this data tree is devoid of key/value pairs

isEmpty() - Method in class space.arim.dazzleconf2.backend.KeyPath

Whether this key path is empty

isFailure() - Method in class space.arim.dazzleconf2.LoadResult

Checks if failed.

isSuccess() - Method in class space.arim.dazzleconf2.LoadResult

Checks if succeeded.

isUsable(C_OLD) - Method in interface space.arim.dazzleconf2.migration.MigrateSource.Filter

Checks whether the given old configuration should be used.

iterateFrom(KeyPath.SequenceBoundary, Consumer<? super CharSequence>) - Method in class space.arim.dazzleconf2.backend.KeyPath

Runs an action for each key part in the sequence.

J

join(Printable...) - Static method in interface space.arim.dazzleconf2.backend.Printable

Joins multiple printable values, appending them one after the other.

K

KebabCaseKeyMapper - Class in space.arim.dazzleconf2.backend

A key mapper which converts lower camel case patterns to kebab case.

KebabCaseKeyMapper() - Constructor for class space.arim.dazzleconf2.backend.KebabCaseKeyMapper

Creates

key(String) - Method in class space.arim.dazzleconf.error.BadValueException.Builder

keyMapper() - Method in interface space.arim.dazzleconf2.ConfigurationDefinition.ReadOptions

The key mapper to use

keyMapper() - Method in interface space.arim.dazzleconf2.ConfigurationDefinition.WriteOptions

The key mapper to use

keyMapper() - Method in interface space.arim.dazzleconf2.engine.DeserializeContext

Gets the key mapper.

keyMapper() - Method in interface space.arim.dazzleconf2.engine.SerializeContext

Gets the key mapper being used

keyMapper(KeyMapper) - Method in class space.arim.dazzleconf2.ConfigurationBuilder

Sets the key mapper

KeyMapper - Interface in space.arim.dazzleconf2.backend

Simple interface for mapping method names into backend configuration keys, and vice versa.

keyPath() - Method in interface space.arim.dazzleconf2.ConfigurationDefinition.ReadOptions

Gets the absolute key path at which the configuration is being read.

keyPath() - Method in interface space.arim.dazzleconf2.engine.DeserializeContext

Gets the absolute key path of the enclosing context.

KeyPath - Class in space.arim.dazzleconf2.backend

A key path consists of an ordered sequence of strings.

KeyPath.Immut - Class in space.arim.dazzleconf2.backend

A key path which is unmistakably immutable.

KeyPath.Mut - Class in space.arim.dazzleconf2.backend

KeyPath.SequenceBoundary - Enum in space.arim.dazzleconf2.backend

Specifies either the start or the end of the key path sequence.

keySet() - Method in class space.arim.dazzleconf2.backend.DataTree

Gets all the keys in this data tree.

L

label() - Method in interface space.arim.dazzleconf2.engine.TypeLiaison.DefaultInit

The label for the entry, typically the method name

labelToKey(CharSequence) - Method in class space.arim.dazzleconf2.backend.DefaultKeyMapper

labelToKey(CharSequence) - Method in class space.arim.dazzleconf2.backend.KebabCaseKeyMapper

labelToKey(CharSequence) - Method in interface space.arim.dazzleconf2.backend.KeyMapper

Turns the argument into a key.

labelToKey(CharSequence) - Method in class space.arim.dazzleconf2.backend.LowerSnakeCaseKeyMapper

LINE_NUMBER - Static variable in interface space.arim.dazzleconf2.ErrorContext

Line number in the source data

load(InputStream) - Method in interface space.arim.dazzleconf.ConfigurationFactory

Reads configuration data from an input stream

load(InputStream) - Method in class space.arim.dazzleconf.factory.BaseConfigurationFactory

Deprecated.

load(InputStream) - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

load(InputStream) - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

load(InputStream, C) - Method in interface space.arim.dazzleconf.ConfigurationFactory

Reads configuration data from an input stream with the given auxiliary configuration instance.

load(InputStream, C) - Method in class space.arim.dazzleconf.factory.BaseConfigurationFactory

Deprecated.

load(InputStream, C) - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

load(InputStream, C) - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

load(ReadableByteChannel) - Method in interface space.arim.dazzleconf.ConfigurationFactory

Reads configuration data from a readable channel

load(ReadableByteChannel) - Method in class space.arim.dazzleconf.factory.BaseConfigurationFactory

Deprecated.

load(ReadableByteChannel) - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

load(ReadableByteChannel) - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

load(ReadableByteChannel, C) - Method in interface space.arim.dazzleconf.ConfigurationFactory

Reads configuration data from a readable channel with the given auxiliary configuration instance.

load(ReadableByteChannel, C) - Method in class space.arim.dazzleconf.factory.BaseConfigurationFactory

Deprecated.

load(ReadableByteChannel, C) - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

load(ReadableByteChannel, C) - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

load(MigrateContext) - Method in class space.arim.dazzleconf2.migration.MigrateFromConfiguration

load(MigrateContext) - Method in interface space.arim.dazzleconf2.migration.MigrateSource

Attempts to load this configuration version.

loadDefaults() - Method in interface space.arim.dazzleconf.ConfigurationFactory

Reads the default configuration data from annotations in ConfDefault

If any config entry is missing a default value annotation, or the default values cannot be deserialised to the appropriate config value, IllDefinedConfigException is thrown

loadDefaults() - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

loadDefaults() - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

loadDefaults() - Method in interface space.arim.dazzleconf2.ConfigurationDefinition

Loads the default configuration.

loadDefaultValues(TypeLiaison.DefaultInit<V>) - Method in interface space.arim.dazzleconf2.engine.TypeLiaison.Agent

Gets default values.

loadFromReader(Reader) - Method in class space.arim.dazzleconf.factory.BaseConfigurationFactory

Deprecated.

Reads config data from the specified reader

loadFromReader(Reader, C) - Method in class space.arim.dazzleconf.factory.BaseConfigurationFactory

Deprecated.

Reads config data from the specified reader with the given auxiliary entries.

loadMap(InputStream) - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

Loads a map of config values from an input stream.

loadMap(InputStream) - Method in class space.arim.dazzleconf.factory.HumanReadableConfigurationFactory

loadMap(Reader) - Method in class space.arim.dazzleconf.factory.HumanReadableConfigurationFactory

Loads a map of config values from a reader

loadMap(ReadableByteChannel) - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

Loads a map of config values from an input channel.

loadMap(ReadableByteChannel) - Method in class space.arim.dazzleconf.factory.HumanReadableConfigurationFactory

loadMapFromReader(Reader) - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

Deprecated.

Loads a raw map of nested values from the specified reader.

LoadResult<R> - Class in space.arim.dazzleconf2

A result container for fallible operations.

locale(Locale) - Method in class space.arim.dazzleconf2.ConfigurationBuilder

Sets the locale for displaying error messages.

location() - Element in annotation type space.arim.dazzleconf2.engine.Comments

Where the comments should be located.

LongDefault - Annotation Type in space.arim.dazzleconf2.engine.liaison

Specifies the default value as a long

LongLiaison - Class in space.arim.dazzleconf2.engine.liaison

Liaison for longs

LongLiaison() - Constructor for class space.arim.dazzleconf2.engine.liaison.LongLiaison

Creates

LongRange - Annotation Type in space.arim.dazzleconf2.engine.liaison

Controls the range of a long.

lookup(MethodHandles.Lookup) - Method in class space.arim.dazzleconf2.ConfigurationBuilder

Changes the lookup used by the library for reflective access.

LowerSnakeCaseKeyMapper - Class in space.arim.dazzleconf2.backend

A key mapper which converts lower camel case patterns to snake case.

LowerSnakeCaseKeyMapper() - Constructor for class space.arim.dazzleconf2.backend.LowerSnakeCaseKeyMapper

Creates

M

mainBackend() - Method in interface space.arim.dazzleconf2.migration.MigrateContext

The backend being used to load the main configuration.

mainMessage() - Method in interface space.arim.dazzleconf2.ErrorContext

Gets the main message to display as the reason for this error.

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.ByteLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.DoubleLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.FloatLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.IntegerLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.LongLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.ShortLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.BooleanLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.CharacterLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.CollectionLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.EnumLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.MapLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.SimpleTypeLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.StringLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in class space.arim.dazzleconf2.engine.liaison.SubSectionLiaison

makeAgent(TypeToken<V>, TypeLiaison.Handshake) - Method in interface space.arim.dazzleconf2.engine.TypeLiaison

Attempts to support the following type.

makeChild(Object) - Method in interface space.arim.dazzleconf2.engine.DeserializeInput

Deprecated.

This method will be removed in 2.0 in favor of 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 "$" + idx as the location.

makeChild(DataEntry, Object) - Method in interface space.arim.dazzleconf2.engine.DeserializeInput

Makes a child at the given subkey and prepares it for deserialization.

makeErrorSource() - Method in interface space.arim.dazzleconf2.Configuration

Creates a convenient error source.

makeInstantiator(MethodHandles.Lookup) - Method in class space.arim.dazzleconf2.reflect.DefaultReflectionService

makeInstantiator(MethodHandles.Lookup) - Method in interface space.arim.dazzleconf2.reflect.ReflectionService

Gets the instantiator this service provides.

makeInvoker(Object, Class<?>) - Method in interface space.arim.dazzleconf2.reflect.MethodMirror

Creates an invoker that allows calling methods on the given receiver.

makeMethodMirror(MethodHandles.Lookup) - Method in class space.arim.dazzleconf2.reflect.DefaultReflectionService

makeMethodMirror(MethodHandles.Lookup) - Method in interface space.arim.dazzleconf2.reflect.ReflectionService

Gets the MethodMirror this service provides.

makeReloadShell(C) - Method in interface space.arim.dazzleconf2.Configuration

Creates a reload shell for this configuration.

makeSerializer() - Method in interface space.arim.dazzleconf2.engine.TypeLiaison.Agent

Makes a serializer for the type.

map(Function<? super R, R_NEW>) - Method in class space.arim.dazzleconf2.LoadResult

Maps from one load result to another.

MapLiaison - Class in space.arim.dazzleconf2.engine.liaison

Liaison for maps.

MapLiaison() - Constructor for class space.arim.dazzleconf2.engine.liaison.MapLiaison

Creates the liaison

matchOnToken(TypeToken<R>, Class<V>, Supplier<TypeLiaison.Agent<V>>) - Static method in interface space.arim.dazzleconf2.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.annote.CollectionSize

The maximum size

max() - Element in annotation type space.arim.dazzleconf.annote.IntegerRange

The maximum value.

max() - Element in annotation type space.arim.dazzleconf.annote.NumericRange

The maximum double value.

max() - Element in annotation type space.arim.dazzleconf2.engine.liaison.ByteRange

The maximum value

max() - Element in annotation type space.arim.dazzleconf2.engine.liaison.DoubleRange

The maximum value.

max() - Element in annotation type space.arim.dazzleconf2.engine.liaison.FloatRange

The maximum value.

max() - Element in annotation type space.arim.dazzleconf2.engine.liaison.IntegerRange

The maximum value.

max() - Element in annotation type space.arim.dazzleconf2.engine.liaison.LongRange

The maximum value

max() - Element in annotation type space.arim.dazzleconf2.engine.liaison.ShortRange

The maximum value

maximumErrorCollect() - Method in interface space.arim.dazzleconf2.ConfigurationDefinition.ReadOptions

The maximum number of errors to collect before exiting.

message(CharSequence) - Method in class space.arim.dazzleconf.error.BadValueException.Builder

message(String) - Method in class space.arim.dazzleconf.error.BadValueException.Builder

meta() - Method in interface space.arim.dazzleconf2.backend.Backend

Gets information about this backend itself.

method() - Method in class space.arim.dazzleconf2.reflect.MethodYield.Entry

Gets the method

methodAnnotations() - Method in interface space.arim.dazzleconf2.engine.TypeLiaison.DefaultInit

Gets method level annotations for the entry being initialized

methodDefault() - Method in interface space.arim.dazzleconf2.engine.TypeLiaison.DefaultInit

Extracts default values from the default method if one exists.

MethodId - Class in space.arim.dazzleconf2.reflect

Identifiers for a method.

MethodId(String, ReifiedType.Annotated, ReifiedType[], boolean) - Constructor for class space.arim.dazzleconf2.reflect.MethodId

Builds from arguments

MethodId.OpaqueCache - Interface in space.arim.dazzleconf2.reflect

A marker interface for cache data appended to a MethodId.

MethodMirror - Interface in space.arim.dazzleconf2.reflect

Service for traversing a type hierarchy and getting and invoking methods on types in that hierarchy.

MethodMirror.Invoker - Interface in space.arim.dazzleconf2.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.dazzleconf2.reflect

Controller for accessing the reflected methods of a given type

MethodYield - Class in space.arim.dazzleconf2.reflect

Bank of values yielded when calling an instantiated proxy.

MethodYield() - Constructor for class space.arim.dazzleconf2.reflect.MethodYield

Creates an empty yield.

MethodYield.Entry - Class in space.arim.dazzleconf2.reflect

An entry added to the method yield

MethodYield.ForImplementable - Class in space.arim.dazzleconf2.reflect

Builder of return value instructions, given an implementable class.

MigrateContext - Interface in space.arim.dazzleconf2.migration

Contextual resources to be used by migrations.

MIGRATED - Enum constant in enum space.arim.dazzleconf2.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.dazzleconf2.ConfigureListener

Notifies that a migration was successful.

migrateFrom(C_OLD, MigrateContext) - Method in interface space.arim.dazzleconf2.migration.Transition

Migrates from one configuration to another

MigrateFromConfiguration<C> - Class in space.arim.dazzleconf2.migration

A migration source from another configuration with this library.

MigrateFromConfiguration(Configuration<C>) - Constructor for class space.arim.dazzleconf2.migration.MigrateFromConfiguration

Creates

MigrateSource<C> - Interface in space.arim.dazzleconf2.migration

A source for an old configuration version.

MigrateSource.Filter<C_OLD> - Interface in space.arim.dazzleconf2.migration

A filter for old configuration versions.

Migration<C_OLD,C_NEW> - Class in space.arim.dazzleconf2.migration

A migration package

Migration(MigrateSource<C_OLD>, Transition<C_OLD, C_NEW>) - Constructor for class space.arim.dazzleconf2.migration.Migration

Creates from a source and transition

migrationSkip(Migration<?, ?>, List<ErrorContext>) - Method in interface space.arim.dazzleconf2.ConfigureListener

Notifies that a migration was attempted, but it failed (for any reason).

min() - Element in annotation type space.arim.dazzleconf.annote.CollectionSize

The minimum size

min() - Element in annotation type space.arim.dazzleconf.annote.IntegerRange

The minimum value.

min() - Element in annotation type space.arim.dazzleconf.annote.NumericRange

The minimum double value.

min() - Element in annotation type space.arim.dazzleconf2.engine.liaison.ByteRange

The minimum value

min() - Element in annotation type space.arim.dazzleconf2.engine.liaison.DoubleRange

The minimum value.

min() - Element in annotation type space.arim.dazzleconf2.engine.liaison.FloatRange

The minimum value.

min() - Element in annotation type space.arim.dazzleconf2.engine.liaison.IntegerRange

The minimum value.

min() - Element in annotation type space.arim.dazzleconf2.engine.liaison.LongRange

The minimum value

min() - Element in annotation type space.arim.dazzleconf2.engine.liaison.ShortRange

The minimum value

MISSING - Enum constant in enum space.arim.dazzleconf2.engine.UpdateReason

Used when an option was missing, so the value was supplied with DefaultValues.ifMissing().

MissingKeyException - Exception Class in space.arim.dazzleconf.error

Indicates a specific key does not exist

MissingValueException - Exception Class in space.arim.dazzleconf.error

Indicates a value is nonexistent (e.g. null) at a specific key

Mut() - Constructor for class space.arim.dazzleconf2.backend.DataList.Mut

Creates

Mut() - Constructor for class space.arim.dazzleconf2.backend.DataTree.Mut

Creates

Mut() - Constructor for class space.arim.dazzleconf2.backend.KeyPath.Mut

Creates an empty key path

Mut(int) - Constructor for class space.arim.dazzleconf2.backend.DataList.Mut

Creates with a capacity hint

Mut(String...) - Constructor for class space.arim.dazzleconf2.backend.KeyPath.Mut

Creates from the given parts

Mut(Collection<DataEntry>) - Constructor for class space.arim.dazzleconf2.backend.DataList.Mut

Creates from the given elements.

Mut(DataEntry...) - Constructor for class space.arim.dazzleconf2.backend.DataList.Mut

Creates from the given elements.

Mut(KeyPath) - Constructor for class space.arim.dazzleconf2.backend.KeyPath.Mut

Creates from another key path.

N

name() - Method in class space.arim.dazzleconf2.reflect.MethodId

The method name

NonEmptyStringValidator - Class in space.arim.dazzleconf.validator

Value validator which ensures a string is not empty

NonEmptyStringValidator() - Constructor for class space.arim.dazzleconf.validator.NonEmptyStringValidator

notifyUpdate(KeyPath, UpdateReason) - Method in interface space.arim.dazzleconf2.engine.DeserializeContext

Signals that the data could use an update with respect to this object.

notifyUpdate(KeyPath, UpdateReason) - Method in interface space.arim.dazzleconf2.engine.UpdateListener

Called when a path is updated, or could be updated.

notifyUpdate(KeyPath, UpdateReason) - Method in interface space.arim.dazzleconf2.migration.MigrateContext

Allows migrations to signal updated paths.

NumericRange - Annotation Type in space.arim.dazzleconf.annote

Controls the range of any numeric type.

O

object() - Method in interface space.arim.dazzleconf2.engine.DeserializeInput

The actual object which is being deserialized.

of(Collection<? extends ValueSerialiser<?>>) - Static method in class space.arim.dazzleconf.serialiser.ValueSerialiserMap

Creates from a collection of serialisers.

of(Map<Class<?>, ? extends ValueSerialiser<?>>) - Static method in class space.arim.dazzleconf.serialiser.ValueSerialiserMap

Creates from a map of serialisers.

of(R) - Static method in class space.arim.dazzleconf2.LoadResult

Makes a successful load result

onCompletion() - Method in class space.arim.dazzleconf2.migration.MigrateFromConfiguration

onCompletion() - Method in interface space.arim.dazzleconf2.migration.MigrateSource

Signals that the migration was fully completed.

onCompletion() - Method in class space.arim.dazzleconf2.migration.Migration

Signals that the migration was fully completed.

onError(List<ErrorContext>) - Method in interface space.arim.dazzleconf2.ErrorPrint

Displays the following error contexts in some way, shape, or form

onError(List<ErrorContext>) - Method in class space.arim.dazzleconf2.StandardErrorPrint

openInputStream(DataRoot.Operation<R, InputStream>) - Method in interface space.arim.dazzleconf2.backend.BinaryRoot

Opens an input stream for the data

openInputStream(DataRoot.Operation<R, InputStream>) - Method in class space.arim.dazzleconf2.backend.PathRoot

openOutputStream(DataRoot.Operation<R, OutputStream>) - Method in interface space.arim.dazzleconf2.backend.BinaryRoot

Opens an output stream to the data

openOutputStream(DataRoot.Operation<R, OutputStream>) - Method in class space.arim.dazzleconf2.backend.PathRoot

openReadChannel(DataRoot.Operation<R, ReadableByteChannel>) - Method in interface space.arim.dazzleconf2.backend.BinaryRoot

Opens a read channel for the data

openReadChannel(DataRoot.Operation<R, ReadableByteChannel>) - Method in class space.arim.dazzleconf2.backend.InputOutputRoot

openReadChannel(DataRoot.Operation<R, ReadableByteChannel>) - Method in class space.arim.dazzleconf2.backend.PathRoot

openReader(DataRoot.Operation<R, Reader>) - Method in class space.arim.dazzleconf2.backend.InputOutputRoot

openReader(DataRoot.Operation<R, Reader>) - Method in class space.arim.dazzleconf2.backend.PathRoot

openReader(DataRoot.Operation<R, Reader>) - Method in interface space.arim.dazzleconf2.backend.ReadableRoot

Opens a reader to the data

openReader(DataRoot.Operation<R, Reader>) - Method in class space.arim.dazzleconf2.backend.StringRoot

openWriteChannel(DataRoot.Operation<R, WritableByteChannel>) - Method in interface space.arim.dazzleconf2.backend.BinaryRoot

Opens a write channel to the data

openWriteChannel(DataRoot.Operation<R, WritableByteChannel>) - Method in class space.arim.dazzleconf2.backend.InputOutputRoot

openWriteChannel(DataRoot.Operation<R, WritableByteChannel>) - Method in class space.arim.dazzleconf2.backend.PathRoot

openWriter(DataRoot.Operation<R, Writer>) - Method in class space.arim.dazzleconf2.backend.InputOutputRoot

openWriter(DataRoot.Operation<R, Writer>) - Method in class space.arim.dazzleconf2.backend.PathRoot

openWriter(DataRoot.Operation<R, Writer>) - Method in interface space.arim.dazzleconf2.backend.ReadableRoot

Opens a writer for the data

openWriter(DataRoot.Operation<R, Writer>) - Method in class space.arim.dazzleconf2.backend.StringRoot

operateUsing(U) - Method in interface space.arim.dazzleconf2.backend.DataRoot.Operation

Performs the operation

opposite() - Method in enum space.arim.dazzleconf2.backend.KeyPath.SequenceBoundary

Returns the opposite boundary of this one.

OTHER - Enum constant in enum space.arim.dazzleconf2.engine.UpdateReason

A catch-all for other or unknown reasons.

outBoolean(boolean) - Method in interface space.arim.dazzleconf2.engine.SerializeOutput

Outputs a boolean

outByte(byte) - Method in interface space.arim.dazzleconf2.engine.SerializeOutput

Outputs a byte

outChar(char) - Method in interface space.arim.dazzleconf2.engine.SerializeOutput

Outputs a character

outDataList(DataList) - Method in interface space.arim.dazzleconf2.engine.SerializeOutput

Outputs a data list

outDataTree(DataTree) - Method in interface space.arim.dazzleconf2.engine.SerializeOutput

Outputs a data tree

outDouble(double) - Method in interface space.arim.dazzleconf2.engine.SerializeOutput

Outputs a double

outFloat(float) - Method in interface space.arim.dazzleconf2.engine.SerializeOutput

Outputs a float

outInt(int) - Method in interface space.arim.dazzleconf2.engine.SerializeOutput

Outputs an integer

outLong(long) - Method in interface space.arim.dazzleconf2.engine.SerializeOutput

Outputs a long

outObjectUnchecked(Object) - Method in interface space.arim.dazzleconf2.engine.SerializeOutput

Outputs the given object.

output(Printable) - Method in interface space.arim.dazzleconf2.ErrorPrint.Output

Outputs the given printable content

outShort(short) - Method in interface space.arim.dazzleconf2.engine.SerializeOutput

Outputs a short

outString(String) - Method in interface space.arim.dazzleconf2.engine.SerializeOutput

Outputs a string

P

parameterAt(int) - Method in class space.arim.dazzleconf2.reflect.MethodId

Gets the parameter at a certain index

parameterCount() - Method in class space.arim.dazzleconf2.reflect.MethodId

The parameter count

parameters() - Method in class space.arim.dazzleconf2.reflect.MethodId

Gets all the parameters

PathRoot - Class in space.arim.dazzleconf2.backend

A data root from a file path.

PathRoot(Path) - Constructor for class space.arim.dazzleconf2.backend.PathRoot

Creates from a path.

PathRoot(Path, Charset) - Constructor for class space.arim.dazzleconf2.backend.PathRoot

Creates from a path and a charset.

preBuilt(CharSequence) - Static method in interface space.arim.dazzleconf2.backend.Printable

Makes a simple implementation based on an existing string.

preservesOrder(boolean) - Method in interface space.arim.dazzleconf2.backend.Backend.Meta

Whether this backend supports preservation of data entry order.

Printable - Interface in space.arim.dazzleconf2.backend

A displayable item, printed in one of multiple ways.

Printable.Abstract - Class in space.arim.dazzleconf2.backend

A base implementation for Printable.

printString() - Method in class space.arim.dazzleconf2.backend.KeyPath

printString() - Method in class space.arim.dazzleconf2.backend.Printable.Abstract

printString() - Method in interface space.arim.dazzleconf2.backend.Printable

Gets the printed content as a string

printTo(Appendable) - Method in class space.arim.dazzleconf2.backend.KeyPath

printTo(Appendable) - Method in interface space.arim.dazzleconf2.backend.Printable

Prints to the given appendable

printTo(StringBuilder) - Method in class space.arim.dazzleconf2.backend.KeyPath

printTo(StringBuilder) - Method in class space.arim.dazzleconf2.backend.Printable.Abstract

printTo(StringBuilder) - Method in interface space.arim.dazzleconf2.backend.Printable

Prints to the given builder

pseudoCommentsSuffix() - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

Deprecated.

If the configuration format does not natively support comments, it is possible to attach a "comment" as a string value before the configuration entry which is to be commented, with the use of some key suffix.

pseudoCommentsSuffix() - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

If the configuration format does not natively support comments, it is possible to attach a "comment" as a string value before the configuration entry which is to be commented, with the use of some key suffix.

put(Object, DataEntry) - Method in class space.arim.dazzleconf2.backend.DataTree.Mut

Sets the entry at the specified key.

Q

query(ErrorContext.Key<V>) - Method in interface space.arim.dazzleconf2.ErrorContext

Gets a piece of detail from this error context, if it is set

R

rawType() - Method in class space.arim.dazzleconf2.reflect.ReifiedType

Gets the raw type, unparameterized

read(ErrorContext.Source) - Method in interface space.arim.dazzleconf2.backend.Backend

Reads data.

ReadableRoot - Interface in space.arim.dazzleconf2.backend

Unifying interface for string based data roots.

readFrom(DataTree) - Method in interface space.arim.dazzleconf2.Configuration

A simple, stateless read from a data tree.

readFrom(DataTree, ConfigurationDefinition.ReadOptions) - Method in interface space.arim.dazzleconf2.ConfigurationDefinition

A simple, stateless read from a data tree.

readFrom(DataTree, UpdateListener) - Method in interface space.arim.dazzleconf2.Configuration

A simple, stateless read from a data tree.

readString() - Method in class space.arim.dazzleconf2.backend.InputOutputRoot

readString() - Method in class space.arim.dazzleconf2.backend.PathRoot

readString() - Method in interface space.arim.dazzleconf2.backend.ReadableRoot

Reads to a string

readString() - Method in class space.arim.dazzleconf2.backend.StringRoot

readWithUpdate(DataTree.Mut, ConfigurationDefinition.ReadWithUpdateOptions) - Method in interface space.arim.dazzleconf2.ConfigurationDefinition

Reads from the data tree given, and updates it as necessary.

recommendKeyMapper() - Method in interface space.arim.dazzleconf2.backend.Backend

Recommends a KeyMapper appropriate to the backend format.

reflectionService(ReflectionService) - Method in class space.arim.dazzleconf2.ConfigurationBuilder

Sets the reflection service.

ReflectionService - Interface in space.arim.dazzleconf2.reflect

A low-level service responsible for generating, instantiating, and invoking methods on arbitrary interface implementations.

ReifiedType - Class in space.arim.dazzleconf2.reflect

A possibly generic type, with its arguments fully specified.

ReifiedType(Class<?>, ReifiedType[]) - Constructor for class space.arim.dazzleconf2.reflect.ReifiedType

Builds from nonnull input arguments.

ReifiedType.Annotated - Class in space.arim.dazzleconf2.reflect

Annotation capable extension to a reified type.

reloadConfigData() - Method in class space.arim.dazzleconf.helper.ConfigurationHelper

Loads/reloads the configuration data.

ReloadShell<C> - Interface in space.arim.dazzleconf2

A handler for managing reloading of an inner configuration object.

remove(Object) - Method in class space.arim.dazzleconf2.backend.DataTree.Mut

Clears any entry at the specified key

requireDataList() - Method in interface space.arim.dazzleconf2.engine.DeserializeInput

Requires the object to be a list of data entries.

requireDataTree() - Method in interface space.arim.dazzleconf2.engine.DeserializeInput

Requires the object to be a data tree, i.e. a map of key/value pairs.

requireString() - Method in interface space.arim.dazzleconf2.engine.DeserializeInput

Requires the object to be a string

returnType() - Method in class space.arim.dazzleconf2.reflect.MethodId

The return type

returnValue() - Method in class space.arim.dazzleconf2.reflect.MethodYield.Entry

Gets the return value for the method, or InvokeDefaultFunction to call the default implementation

returnValue(MethodId, Object) - Method in class space.arim.dazzleconf2.reflect.MethodYield.ForImplementable

Specifies to return the given value.

S

serialise(URL, Decomposer) - Method in class space.arim.dazzleconf.serialiser.URLValueSerialiser

serialise(T, Decomposer) - Method in interface space.arim.dazzleconf.serialiser.ValueSerialiser

Serializes a value to a raw config value.

serialize(V, SerializeOutput) - Method in interface space.arim.dazzleconf2.engine.SerializeDeserialize

Serializes this value.

SerializeContext - Interface in space.arim.dazzleconf2.engine

A context for serialization.

SerializeDeserialize<V> - Interface in space.arim.dazzleconf2.engine

A serializer.

SerializeOutput - Interface in space.arim.dazzleconf2.engine

The output for serialization, which is handed to SerializeDeserialize.serialize(V, space.arim.dazzleconf2.engine.SerializeOutput).

set(int, DataEntry) - Method in class space.arim.dazzleconf2.backend.DataList.Mut

Replaces the element at the given index

setAt(CommentLocation, String...) - Method in class space.arim.dazzleconf2.backend.CommentData

Attaches comments and returns a new object.

setAt(CommentLocation, List<String>) - Method in class space.arim.dazzleconf2.backend.CommentData

Attaches comments and returns a new object.

setCreateSingleElementCollections(boolean) - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder

Specifies whether, when a configuration value is desired as some kind of collection, but the config value is not a collection, a single element collection should be created from the value and used.

setCurrentDelegate(C) - Method in interface space.arim.dazzleconf2.ReloadShell

Sets the inner configuration object to the provided value.

setStrictParseEnums(boolean) - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder

Specifies whether enum values should be strictly parsed.

ShortDefault - Annotation Type in space.arim.dazzleconf2.engine.liaison

Specifies the default value as a short.

ShortLiaison - Class in space.arim.dazzleconf2.engine.liaison

Liaison for shorts

ShortLiaison() - Constructor for class space.arim.dazzleconf2.engine.liaison.ShortLiaison

Creates

ShortRange - Annotation Type in space.arim.dazzleconf2.engine.liaison

Controls the range of a short.

simple(V) - Static method in interface space.arim.dazzleconf2.engine.DefaultValues

Creates a simple implementation from the given value.

simple(DataTree) - Static method in interface space.arim.dazzleconf2.backend.Backend.Document

Returns a document consisting of the following data, without commments

SimpleTypeLiaison<U> - Class in space.arim.dazzleconf2.engine.liaison

A simple type liaison that wraps a SerializeDeserialize.

SimpleTypeLiaison(TypeToken<U>, SerializeDeserialize<U>) - Constructor for class space.arim.dazzleconf2.engine.liaison.SimpleTypeLiaison

Creates from a type token and the provided serialization

size() - Method in class space.arim.dazzleconf2.backend.DataList.Immut

size() - Method in class space.arim.dazzleconf2.backend.DataList.Mut

size() - Method in class space.arim.dazzleconf2.backend.DataList

The number of elements in this data tree indicates its size

size() - Method in class space.arim.dazzleconf2.backend.DataTree

The number of key/value pairs in this data tree indicates its size

size() - Method in class space.arim.dazzleconf2.backend.KeyPath

Gets the number of key parts in the sequence

sizeEstimate() - Method in class space.arim.dazzleconf2.reflect.MethodYield

Gets the estimated number of entries

SortableConfigurationEntry - Interface in space.arim.dazzleconf.sorter

An entry in a configuration.

sorter(ConfigurationSorter) - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder

Sets the ConfigurationSorter to use when writing the configuration to a stream or channel.

space.arim.dazzleconf - package space.arim.dazzleconf

Base package containing classes which most usage will involve.

space.arim.dazzleconf.annote - package space.arim.dazzleconf.annote

Defines annotations which control the behaviour of configuration entries.

space.arim.dazzleconf.error - package space.arim.dazzleconf.error

Contains the hierarchy of config-related exceptions, primarily those relating to mistakes in user input.

space.arim.dazzleconf.factory - package space.arim.dazzleconf.factory

Provides abstract ConfigurationFactory implementations useful for those implementing their own format support.

space.arim.dazzleconf.helper - package space.arim.dazzleconf.helper

Optional helper classes which reduce boilerplate related to common setups.

space.arim.dazzleconf.serialiser - package space.arim.dazzleconf.serialiser

Contains all API related to serializing and deserializing, commonly used for adding custom config objects.

space.arim.dazzleconf.sorter - package space.arim.dazzleconf.sorter

Enables sorting configuration entries by certain attributes

space.arim.dazzleconf.validator - package space.arim.dazzleconf.validator

Allows arbitrary value validation beyond that provided by the type system or annotations in space.arim.dazzleconf.annote

space.arim.dazzleconf2 - package space.arim.dazzleconf2

Version 2 of the library, provided as a separate package.

space.arim.dazzleconf2.backend - package space.arim.dazzleconf2.backend

This package defines a framework for interactions between the library and the configuration format.

space.arim.dazzleconf2.engine - package space.arim.dazzleconf2.engine

space.arim.dazzleconf2.engine.liaison - package space.arim.dazzleconf2.engine.liaison

space.arim.dazzleconf2.migration - package space.arim.dazzleconf2.migration

An optional API for migrations.

space.arim.dazzleconf2.reflect - package space.arim.dazzleconf2.reflect

StandardErrorPrint - Class in space.arim.dazzleconf2

Usable implementation of ErrorPrint that formats the error message in a language-independent fashion.

StandardErrorPrint(ErrorPrint.Output) - Constructor for class space.arim.dazzleconf2.StandardErrorPrint

Creates from the given output

strictParseEnums() - Method in class space.arim.dazzleconf.ConfigurationOptions

Whether enums are strictly parsed.

StringDefault - Annotation Type in space.arim.dazzleconf2.engine.liaison

Specifies the default value as string.

StringLiaison - Class in space.arim.dazzleconf2.engine.liaison

Liaison for strings.

StringLiaison() - Constructor for class space.arim.dazzleconf2.engine.liaison.StringLiaison

Creates

StringRoot - Class in space.arim.dazzleconf2.backend

Implementation of data root for a string

StringRoot(String) - Constructor for class space.arim.dazzleconf2.backend.StringRoot

Creates from the given initial ccontent

SubSection - Annotation Type in space.arim.dazzleconf.annote

Specifies either that the config entry is a configuration section, or that a generic parameter of a collection (a collection element or map value) is a configuration section.

SubSection - Annotation Type in space.arim.dazzleconf2.engine.liaison

Specifies that an interface is a configuration subsection.

SubSectionLiaison - Class in space.arim.dazzleconf2.engine.liaison

A type liaison that enables using subsection configurations.

SubSectionLiaison() - Constructor for class space.arim.dazzleconf2.engine.liaison.SubSectionLiaison

Creates

supportsComments(boolean, boolean, CommentLocation) - Method in interface space.arim.dazzleconf2.backend.Backend.Meta

Whether comments are supported in the following context.

supportsCommentsThroughWrapper() - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

Deprecated.

Whether this implementation actively supports comments by recognising CommentedWrapper in config values.

supportsCommentsThroughWrapper() - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

Whether this implementation actively supports comments by recognising CommentedWrapper in config values.

SYNTAX_LINTER - Static variable in interface space.arim.dazzleconf2.ErrorContext

A URL pointing to an online syntax linter.

T

throwError(CharSequence) - Method in interface space.arim.dazzleconf2.ErrorContext.Source

Builds an error context, wraps it in a LoadResult and returns it.

throwError(Printable) - Method in interface space.arim.dazzleconf2.ErrorContext.Source

Builds an error context, wraps it in a LoadResult and returns it.

toString() - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder

toString() - Method in class space.arim.dazzleconf.ConfigurationOptions

toString() - Method in class space.arim.dazzleconf.factory.CommentedWrapper

toString() - Method in class space.arim.dazzleconf.serialiser.ValueSerialiserMap

toString() - Method in class space.arim.dazzleconf2.backend.CommentData

toString() - Method in class space.arim.dazzleconf2.backend.DataEntry

toString() - Method in class space.arim.dazzleconf2.backend.DataList

toString() - Method in class space.arim.dazzleconf2.backend.DataTree

toString() - Method in class space.arim.dazzleconf2.backend.KeyPath

toString() - Method in class space.arim.dazzleconf2.backend.Printable.Abstract

toString() - Method in interface space.arim.dazzleconf2.backend.Printable

Gets a string representation.

toString() - Method in class space.arim.dazzleconf2.LoadResult

toString() - Method in class space.arim.dazzleconf2.reflect.MethodId

toString() - Method in class space.arim.dazzleconf2.reflect.MethodYield

toString() - Method in class space.arim.dazzleconf2.reflect.ReifiedType

toString() - Method in class space.arim.dazzleconf2.reflect.TypeToken

Transition<C_OLD,C_NEW> - Interface in space.arim.dazzleconf2.migration

Converter interface for moving from one configuration object to another

tryMigrate(MigrateContext) - Method in class space.arim.dazzleconf2.migration.Migration

Tries to migrate.

TypeLiaison - Interface in space.arim.dazzleconf2.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.dazzleconf2.engine

An agent that is ready to handle matters relating to a type

TypeLiaison.DefaultInit<V> - Interface in space.arim.dazzleconf2.engine

Provides relevant resources related to default value creation

TypeLiaison.Handshake - Interface in space.arim.dazzleconf2.engine

Callback interface allowing TypeLiaison.Agent to access certain resources

TypeToken<V> - Class in space.arim.dazzleconf2.reflect

Token for handling configuration-related types at runtime.

TypeToken() - Constructor for class space.arim.dazzleconf2.reflect.TypeToken

Creates from a subclass.

TypeToken(ReifiedType.Annotated) - Constructor for class space.arim.dazzleconf2.reflect.TypeToken

Creates from a reified type.

typeWalker(ReifiedType.Annotated) - Method in interface space.arim.dazzleconf2.reflect.MethodMirror

Makes a type walker for the given type.

U

unannotated() - Static method in class space.arim.dazzleconf2.reflect.ReifiedType.Annotated

Gets a dummy annotated element, containing no annotations.

unannotated(Class<?>) - Static method in class space.arim.dazzleconf2.reflect.ReifiedType.Annotated

Creates an unparameterized, unannotated reified type for the following raw class.

UPDATED - Enum constant in enum space.arim.dazzleconf2.engine.UpdateReason

An existing option was updated to another value.

UpdateListener - Interface in space.arim.dazzleconf2.engine

Listener that lets the implementor know when paths were updated.

UpdateReason - Enum in space.arim.dazzleconf2.engine

A reason why a particular path within a configuration was updated

URLValueSerialiser - Class in space.arim.dazzleconf.serialiser

Value serialiser for URL

V

validate(String, Object) - Method in class space.arim.dazzleconf.validator.NonEmptyStringValidator

validate(String, Object) - Method in interface space.arim.dazzleconf.validator.ValueValidator

Validates a value.

validateKey(Object) - Static method in class space.arim.dazzleconf2.backend.DataTree

Checks whether the given object is valid as a key in the data tree.

validateValue(Object) - Static method in class space.arim.dazzleconf2.backend.DataEntry

Checks whether the given object is valid as a value.

value() - Element in annotation type space.arim.dazzleconf.annote.ConfComments

The comments on this entry.

value() - Element in annotation type space.arim.dazzleconf.annote.ConfDefault.DefaultBoolean

value() - Element in annotation type space.arim.dazzleconf.annote.ConfDefault.DefaultBooleans

value() - Element in annotation type space.arim.dazzleconf.annote.ConfDefault.DefaultDouble

value() - Element in annotation type space.arim.dazzleconf.annote.ConfDefault.DefaultDoubles

value() - Element in annotation type space.arim.dazzleconf.annote.ConfDefault.DefaultInteger

value() - Element in annotation type space.arim.dazzleconf.annote.ConfDefault.DefaultIntegers

value() - Element in annotation type space.arim.dazzleconf.annote.ConfDefault.DefaultLong

value() - Element in annotation type space.arim.dazzleconf.annote.ConfDefault.DefaultLongs

value() - Element in annotation type space.arim.dazzleconf.annote.ConfDefault.DefaultMap

value() - Element in annotation type space.arim.dazzleconf.annote.ConfDefault.DefaultObject

value() - Element in annotation type space.arim.dazzleconf.annote.ConfDefault.DefaultString

value() - Element in annotation type space.arim.dazzleconf.annote.ConfDefault.DefaultStrings

value() - Element in annotation type space.arim.dazzleconf.annote.ConfHeader

The comment header itself.

value() - Element in annotation type space.arim.dazzleconf.annote.ConfKey

Defines the key at which this entry's data should be pulled from.

value() - Element in annotation type space.arim.dazzleconf.annote.ConfSerialisers

Specifies additional ValueSerialisers to use for this configuration interface.

value() - Element in annotation type space.arim.dazzleconf.annote.ConfValidator

Specifies the ValueValidator to use for this config entry.

value() - Element in annotation type space.arim.dazzleconf.sorter.AnnotationBasedSorter.Order

The order of this config entry.

value() - Element in annotation type space.arim.dazzleconf2.engine.Comments.Container

The values in this container.

value() - Element in annotation type space.arim.dazzleconf2.engine.Comments

The comments themselves.

value() - Element in annotation type space.arim.dazzleconf2.engine.liaison.BooleanDefault

The boolean value to provide as a default

value() - Element in annotation type space.arim.dazzleconf2.engine.liaison.ByteDefault

The byte value to provide as a default

value() - Element in annotation type space.arim.dazzleconf2.engine.liaison.DoubleDefault

The double value to provide as a default.

value() - Element in annotation type space.arim.dazzleconf2.engine.liaison.FloatDefault

The float value to provide as a default.

value() - Element in annotation type space.arim.dazzleconf2.engine.liaison.IntegerDefault

The integer value to provide as a default

value() - Element in annotation type space.arim.dazzleconf2.engine.liaison.LongDefault

The long value to provide as a default.

value() - Element in annotation type space.arim.dazzleconf2.engine.liaison.ShortDefault

The short value to provide as a default.

value() - Element in annotation type space.arim.dazzleconf2.engine.liaison.StringDefault

The string value to provide as a default

valueOf(String) - Static method in enum space.arim.dazzleconf2.backend.KeyPath.SequenceBoundary

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum space.arim.dazzleconf2.engine.CommentLocation

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum space.arim.dazzleconf2.engine.UpdateReason

Returns the enum constant of this type with the specified name.

values() - Static method in enum space.arim.dazzleconf2.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.dazzleconf2.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.dazzleconf2.engine.UpdateReason

Returns an array containing the constants of this enum type, in the order they are declared.

ValueSerialiser<T> - Interface in space.arim.dazzleconf.serialiser

User-implemented interface for serializing and deserializing configuration entries.

ValueSerialiserMap - Class in space.arim.dazzleconf.serialiser

An immutable map of value serialisers, keyed by the type which they serialise.

valuesFor(Class<?>) - Method in class space.arim.dazzleconf2.reflect.MethodYield

Gets the yieldable values

ValueValidator - Interface in space.arim.dazzleconf.validator

Functional interface for validating configuration entries.

W

withComments(CommentData) - Method in class space.arim.dazzleconf2.backend.DataEntry

Sets the comments and returns a new object

withComments(CommentLocation, List<String>) - Method in class space.arim.dazzleconf2.backend.DataEntry

Sets comments at the given location and returns a new object.

withLineNumber(int) - Method in class space.arim.dazzleconf2.backend.DataEntry

Sets the line number and returns a new object

withOpaqueCache(MethodId.OpaqueCache) - Method in class space.arim.dazzleconf2.reflect.MethodId

Creates a new method ID, with the argument set as the opaque cache.

withValue(Object) - Method in class space.arim.dazzleconf2.backend.DataEntry

Sets the value and returns a new object

write(C, OutputStream) - Method in interface space.arim.dazzleconf.ConfigurationFactory

Writes configuration data to an output stream

write(C, OutputStream) - Method in class space.arim.dazzleconf.factory.BaseConfigurationFactory

Deprecated.

write(C, OutputStream) - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

write(C, OutputStream) - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

write(C, WritableByteChannel) - Method in interface space.arim.dazzleconf.ConfigurationFactory

Writes configuration data to a writable byte channel

write(C, WritableByteChannel) - Method in class space.arim.dazzleconf.factory.BaseConfigurationFactory

Deprecated.

write(C, WritableByteChannel) - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

write(C, WritableByteChannel) - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

write(Backend.Document) - Method in interface space.arim.dazzleconf2.backend.Backend

Writes the provided data tree to the source.

writeEntryComments(CommentLocation) - Method in interface space.arim.dazzleconf2.ConfigurationDefinition.ReadWithUpdateOptions

Controls whether comments on existing data entries are refreshed.

writeEntryComments(CommentLocation) - Method in interface space.arim.dazzleconf2.ConfigurationDefinition.WriteOptions

Controls whether comments are written to data entries.

writeEntryComments(CommentLocation) - Method in interface space.arim.dazzleconf2.engine.SerializeContext

Checks whether comments are being written on entries, and if so, where.

writeMap(Map<String, Object>, OutputStream) - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

Writes a map of config values to an output stream

writeMap(Map<String, Object>, OutputStream) - Method in class space.arim.dazzleconf.factory.HumanReadableConfigurationFactory

writeMap(Map<String, Object>, Writer) - Method in class space.arim.dazzleconf.factory.HumanReadableConfigurationFactory

Writes a map of config values to a writer

writeMap(Map<String, Object>, WritableByteChannel) - Method in class space.arim.dazzleconf.factory.ConfigurationFormatFactory

Writes a map of config values to an output channel

writeMap(Map<String, Object>, WritableByteChannel) - Method in class space.arim.dazzleconf.factory.HumanReadableConfigurationFactory

writeMapToWriter(Map<String, Object>, Writer) - Method in class space.arim.dazzleconf.factory.AbstractConfigurationFactory

Deprecated.

Writes a raw map of nested values to the specified writer.

writesFloatAsDouble() - Method in interface space.arim.dazzleconf2.backend.Backend.Meta

Whether the backend writes float values by casting them to double.

writeString(String) - Method in class space.arim.dazzleconf2.backend.InputOutputRoot

writeString(String) - Method in class space.arim.dazzleconf2.backend.PathRoot

writeString(String) - Method in interface space.arim.dazzleconf2.backend.ReadableRoot

Writes to a string

writeString(String) - Method in class space.arim.dazzleconf2.backend.StringRoot

writeTo(C, DataTree.Mut) - Method in interface space.arim.dazzleconf2.Configuration

Writes to the given data tree.

writeTo(C, DataTree.Mut, ConfigurationDefinition.WriteOptions) - Method in interface space.arim.dazzleconf2.ConfigurationDefinition

Writes to the given data tree.

writeToWriter(C, Writer) - Method in class space.arim.dazzleconf.factory.BaseConfigurationFactory

Deprecated.

Writes config data to the specified writer

wroteDefaults() - Method in interface space.arim.dazzleconf2.ConfigureListener

Signals that the configuration didn't exist, so the whole thing was freshly written from default values.

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Serialized Form