Index (dazzleconf-core 1.2.0-RC1 API)

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

A

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
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
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
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
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

BadValueException - Exception 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 from FlexibleType.getAssociatedKey()
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
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
Builder() - Constructor for class space.arim.dazzleconf.ConfigurationOptions.Builder: Creates the builder.
Builder() - Constructor for class space.arim.dazzleconf.error.BadValueException.Builder

C

cause(Throwable) - Method in class space.arim.dazzleconf.error.BadValueException.Builder
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
clearSerialisers() - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder: Clears the serialisers of this builder
clearValidators() - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder: Clears the validators of this builder
CollectionSize - Annotation Type in space.arim.dazzleconf.annote: Applied to lists, sets, collections, and maps in order to limit their size
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
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 in space.arim.dazzleconf.error: Indicates the syntax of a specific config format is invalid
ConfigFormatSyntaxException() - Constructor for exception space.arim.dazzleconf.error.ConfigFormatSyntaxException: Creates the exception
ConfigFormatSyntaxException(String) - Constructor for exception space.arim.dazzleconf.error.ConfigFormatSyntaxException: Creates the exception with an exception message
ConfigFormatSyntaxException(String, Throwable) - Constructor for exception space.arim.dazzleconf.error.ConfigFormatSyntaxException: Creates the exception with an exception message and cause
ConfigFormatSyntaxException(Throwable) - Constructor for exception space.arim.dazzleconf.error.ConfigFormatSyntaxException: Creates the exception with a cause
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.
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
createSingleElementCollections() - Method in class space.arim.dazzleconf.ConfigurationOptions: Whether single element collections are created for config values which were not originally collections

D

decompose(Class<T>, T) - Method in interface space.arim.dazzleconf.serialiser.Decomposer: Decomposes an object of a certain type, using a value serialiser 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.
defaults() - Static method in class space.arim.dazzleconf.ConfigurationOptions: Returns the default configuration options
deserialise(FlexibleType) - Method in class space.arim.dazzleconf.serialiser.URLValueSerialiser
deserialise(FlexibleType) - Method in interface space.arim.dazzleconf.serialiser.ValueSerialiser: Deserialises a value from a flexible type representing a raw config value.

E

empty() - Static method in class space.arim.dazzleconf.serialiser.ValueSerialiserMap: Gets an empty value serialiser map
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

F

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
forKey(String) - Static method in exception space.arim.dazzleconf.error.MissingKeyException: Creates the exception using the given key
forKey(String) - Static method in exception space.arim.dazzleconf.error.MissingValueException: Creates the exception using the given key
forKeyAndMessage(String, String) - Static method in exception space.arim.dazzleconf.error.MissingKeyException: Creates the exception with the given key and message
forKeyAndMessage(String, String) - Static method in exception space.arim.dazzleconf.error.MissingValueException: Creates the exception with the given key and message

G

getAssociatedKey() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType: Gets the key associated with this flexible type.
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
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
getConfigurationSorter() - Method in class space.arim.dazzleconf.ConfigurationOptions: Gets the configuration sorter
getDouble() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType: Gets the value as a double
getEnum(Class<T>) - Method in interface space.arim.dazzleconf.serialiser.FlexibleType: Gets the value as an enum type
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
getInteger() - Method in interface space.arim.dazzleconf.serialiser.FlexibleType: Gets the value as an integer
getKey() - Method in exception 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.
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.
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
getObject(Class<T>) - Method in interface space.arim.dazzleconf.serialiser.FlexibleType: Gets this type as some arbitrary object.
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
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.
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
getTargetClass() - Method in class space.arim.dazzleconf.serialiser.URLValueSerialiser
getTargetClass() - Method in interface space.arim.dazzleconf.serialiser.ValueSerialiser: Gets the target type of deserialisation
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

H

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
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

IllDefinedConfigException - Exception 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 space.arim.dazzleconf.error.IllDefinedConfigException: Creates the exception
IllDefinedConfigException(String) - Constructor for exception space.arim.dazzleconf.error.IllDefinedConfigException: Creates the exception with an exception message
IllDefinedConfigException(String, Throwable) - Constructor for exception space.arim.dazzleconf.error.IllDefinedConfigException: Creates the exception with an exception message and cause
IllDefinedConfigException(Throwable) - Constructor for exception space.arim.dazzleconf.error.IllDefinedConfigException: Creates the exception with a cause
ImproperEntryException - Exception in space.arim.dazzleconf.error: General exception indicating a problem with a specific configuration entry
IntegerRange - Annotation Type in space.arim.dazzleconf.annote: Controls the range of an numeric type.
InvalidConfigException - Exception in space.arim.dazzleconf.error: Thrown to indicate an invalid configuration
InvalidConfigException() - Constructor for exception space.arim.dazzleconf.error.InvalidConfigException: Creates the exception
InvalidConfigException(String) - Constructor for exception space.arim.dazzleconf.error.InvalidConfigException: Creates the exception with an exception message
InvalidConfigException(String, Throwable) - Constructor for exception space.arim.dazzleconf.error.InvalidConfigException: Creates the exception with an exception message and cause
InvalidConfigException(Throwable) - Constructor for exception space.arim.dazzleconf.error.InvalidConfigException: Creates the exception with a cause

K

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

L

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
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
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.

M

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.
message(String) - Method in class space.arim.dazzleconf.error.BadValueException.Builder
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.
MissingKeyException - Exception in space.arim.dazzleconf.error: Indicates a specific key does not exist
MissingValueException - Exception in space.arim.dazzleconf.error: Indicates a value is nonexistent (e.g.

N

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
NumericRange - Annotation Type in space.arim.dazzleconf.annote: Controls the range of any numeric type.

O

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.

P

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.

R

reloadConfigData() - Method in class space.arim.dazzleconf.helper.ConfigurationHelper: Loads/reloads the configuration data.

S

serialise(URL, Decomposer) - Method in class space.arim.dazzleconf.serialiser.URLValueSerialiser
serialise(T, Decomposer) - Method in interface space.arim.dazzleconf.serialiser.ValueSerialiser: Serialises a value to a raw config value.
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.
setStrictParseEnums(boolean) - Method in class space.arim.dazzleconf.ConfigurationOptions.Builder: Specifies whether enum values should be strictly parsed.
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
strictParseEnums() - Method in class space.arim.dazzleconf.ConfigurationOptions: Whether enums are strictly parsed.
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.
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.

T

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

U

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.
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.
ValueSerialiser<T> - Interface in space.arim.dazzleconf.serialiser: Functional interface for serialising and deserialising configuration entries.
ValueSerialiserMap - Class in space.arim.dazzleconf.serialiser: An immutable map of value serialisers, keyed by the type which they serialise.
ValueValidator - Interface in space.arim.dazzleconf.validator: Functional interface for validating configuration entries.

W

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
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.
writeToWriter(C, Writer) - Method in class space.arim.dazzleconf.factory.BaseConfigurationFactory: Deprecated.

Writes config data to the specified writer

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