Index (configlib-core 4.5.0 API)

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

A

addPostProcessor(Predicate<? super ConfigurationElement<?>>, UnaryOperator<?>) - Method in class de.exlll.configlib.ConfigurationProperties.Builder: Defines a post-processor for each configuration element that fulfils the given condition.
addSerializer(Class<T>, Serializer<? super T, ?>) - Method in class de.exlll.configlib.ConfigurationProperties.Builder: Adds a serializer for the given type.
addSerializerFactory(Class<T>, Function<? super SerializerContext, ? extends Serializer<T, ?>>) - Method in class de.exlll.configlib.ConfigurationProperties.Builder: Adds a serializer factory for the given type.
alias() - Element in annotation interface de.exlll.configlib.PolymorphicTypes.Type: Returns the alias of the subtype.
and(Predicate<? super ConfigurationElement<?>>) - Method in interface de.exlll.configlib.ConfigurationElementFilter
and(Predicate<? super Field>) - Method in interface de.exlll.configlib.FieldFilter
annotatedType() - Method in interface de.exlll.configlib.ConfigurationElement: Returns the annotated type of the element.
annotatedType() - Method in interface de.exlll.configlib.SerializerContext: Returns the AnnotatedType which led to the selection of the serializer.
annotation(Class<A>) - Method in interface de.exlll.configlib.ConfigurationElement: Returns the annotation of the given type or null if the element is not annotated with such an annotation.
apply(String) - Method in interface de.exlll.configlib.NameFormatter: Formats the name of a configuration element.

B

build() - Method in class de.exlll.configlib.ConfigurationProperties.Builder: Builds a ConfigurationProperties instance.
build() - Method in class de.exlll.configlib.FileConfigurationProperties.Builder: Builds a ConfigurationProperties instance.
Builder() - Constructor for class de.exlll.configlib.ConfigurationProperties.Builder
Builder() - Constructor for class de.exlll.configlib.FileConfigurationProperties.Builder: The default constructor.
Builder(ConfigurationProperties) - Constructor for class de.exlll.configlib.ConfigurationProperties.Builder
Builder(FileConfigurationProperties) - Constructor for class de.exlll.configlib.FileConfigurationProperties.Builder: A constructor that initializes this builder with values taken from the properties object.
byPostProcessKey(String) - Static method in interface de.exlll.configlib.ConfigurationElementFilter: Creates a new ConfigurationElementFilter whose test method returns true if the tested configuration element is annotated with a PostProcess annotation whose key equals key.
byType(Class<?>) - Static method in interface de.exlll.configlib.ConfigurationElementFilter: Creates a new ConfigurationElementFilter whose test method returns true if the tested configuration element is of the given type.

C

charset(Charset) - Method in class de.exlll.configlib.FileConfigurationProperties.Builder: Sets the charset used to read and write configuration files.
Comment - Annotation Interface in de.exlll.configlib: Indicates that the annotated element is saved together with explanatory comments describing it.
Configuration - Annotation Interface in de.exlll.configlib: Indicates that the annotated type is a configuration.
ConfigurationElement<T extends AnnotatedElement> - Interface in de.exlll.configlib: Represents an element of a serializable configuration type.
ConfigurationElementFilter - Interface in de.exlll.configlib: Implementations of this interface test configuration elements for specific conditions.
ConfigurationException - Exception in de.exlll.configlib: Signals that an error occurred during the serialization or deserialization of a configuration.
ConfigurationProperties - Class in de.exlll.configlib: A collection of values used to configure the serialization of configurations.
ConfigurationProperties(ConfigurationProperties.Builder<?>) - Constructor for class de.exlll.configlib.ConfigurationProperties: Constructs a new instance of this class with values taken from the given builder.
ConfigurationProperties.Builder<B extends ConfigurationProperties.Builder<B>> - Class in de.exlll.configlib: A builder class for constructing ConfigurationProperties.
createParentDirectories() - Method in class de.exlll.configlib.FileConfigurationProperties: Returns whether to create parent directories.
createParentDirectories(boolean) - Method in class de.exlll.configlib.FileConfigurationProperties.Builder: Sets whether parent directories of a configuration file should be created.

D

de.exlll.configlib - package de.exlll.configlib
declaringType() - Method in interface de.exlll.configlib.ConfigurationElement: Returns the configuration type that defines this element.
DEFAULT_PROPERTY - Static variable in annotation interface de.exlll.configlib.Polymorphic: The default name of the property that holds the type information.
deserialize(T2) - Method in interface de.exlll.configlib.Serializer: Deserializes an element of type T2 into an element of type T1.

E

element() - Method in interface de.exlll.configlib.ConfigurationElement: Returns the element itself.
element() - Method in interface de.exlll.configlib.SerializerContext: Returns the ConfigurationElement for which this serializer was selected.

F

FieldFilter - Interface in de.exlll.configlib: Implementations of this interface test fields for specific conditions.
FileConfigurationProperties - Class in de.exlll.configlib: An extension of the ConfigurationProperties class that allows configuring properties that are more specific to files.
FileConfigurationProperties(FileConfigurationProperties.Builder<?>) - Constructor for class de.exlll.configlib.FileConfigurationProperties: Constructs a new instance of this class with values taken from the given builder.
FileConfigurationProperties.Builder<B extends FileConfigurationProperties.Builder<B>> - Class in de.exlll.configlib: A builder class for constructing FileConfigurationProperties.
FileConfigurationStore<T> - Interface in de.exlll.configlib: Instances of this class save and load configurations using files.
footer(String) - Method in class de.exlll.configlib.FileConfigurationProperties.Builder: Sets the footer.
format(String) - Method in interface de.exlll.configlib.NameFormatter: Formats the name of a configuration element.

G

getCharset() - Method in class de.exlll.configlib.FileConfigurationProperties: Returns the charset used to read and write configuration files.
getFieldFilter() - Method in class de.exlll.configlib.ConfigurationProperties: Returns the field filter used to filter the fields of a configuration class.
getFooter() - Method in class de.exlll.configlib.FileConfigurationProperties: Returns the footer.
getHeader() - Method in class de.exlll.configlib.FileConfigurationProperties: Returns the header.
getNameFormatter() - Method in class de.exlll.configlib.ConfigurationProperties: Returns the name formatter used to format the names of configuration elements.
getPostProcessorsByCondition() - Method in class de.exlll.configlib.ConfigurationProperties: Returns an unmodifiable map of post-processors by condition.
getSerializerFactories() - Method in class de.exlll.configlib.ConfigurationProperties: Returns an unmodifiable map of serializer factories by type.
getSerializers() - Method in class de.exlll.configlib.ConfigurationProperties: Returns an unmodifiable map of serializers by type.
getThis() - Method in class de.exlll.configlib.ConfigurationProperties.Builder: Returns this builder.
getThis() - Method in class de.exlll.configlib.FileConfigurationProperties.Builder: Returns this builder.

H

header(String) - Method in class de.exlll.configlib.FileConfigurationProperties.Builder: Sets the header.

I

IDENTITY - Enum constant in enum class de.exlll.configlib.NameFormatters: A NameFormatter that simply returns the given name.
Ignore - Annotation Interface in de.exlll.configlib: Indicates that the annotated field should not be serialized.
inputNulls() - Method in class de.exlll.configlib.ConfigurationProperties: Returns whether null values should be allowed as input.
inputNulls(boolean) - Method in class de.exlll.configlib.ConfigurationProperties.Builder: Sets whether configuration elements, or collection elements should allow null values to bet set while deserializing the configuration.
IOStreamConfigurationStore<T> - Interface in de.exlll.configlib: Instances of this class read and write configurations from input streams and to output streams, respectively.

K

key() - Element in annotation interface de.exlll.configlib.PostProcess: Returns some key that can be used for filtering configuration elements.

L

load(Path) - Method in interface de.exlll.configlib.FileConfigurationStore: Loads a configuration from the given file.
LOWER_KEBAB_CASE - Enum constant in enum class de.exlll.configlib.NameFormatters: A NameFormatter that transforms camelCase to lower-kebab-case.
LOWER_UNDERSCORE - Enum constant in enum class de.exlll.configlib.NameFormatters: A NameFormatter that transforms camelCase to lower_underscore.

N

name() - Method in interface de.exlll.configlib.ConfigurationElement: Returns the name of the element.
NameFormatter - Interface in de.exlll.configlib: Implementations of this interface format the names of configuration elements.
NameFormatters - Enum Class in de.exlll.configlib: This class contains instances of ready-to-use NameFormatters.
nesting() - Element in annotation interface de.exlll.configlib.SerializeWith: Returns the nesting level at which to apply the serializer.
newBuilder() - Static method in class de.exlll.configlib.ConfigurationProperties: Constructs a new Builder with default values.
newBuilder() - Static method in class de.exlll.configlib.FileConfigurationProperties: Constructs a new Builder with default values.

O

outputNulls() - Method in class de.exlll.configlib.ConfigurationProperties: Returns whether null values should be output.
outputNulls(boolean) - Method in class de.exlll.configlib.ConfigurationProperties.Builder: Sets whether configuration elements, or collection elements whose value is null should be output while serializing the configuration.

P

Polymorphic - Annotation Interface in de.exlll.configlib: Indicates that the annotated type is polymorphic.
PolymorphicTypes - Annotation Interface in de.exlll.configlib: Indicates the subtypes of Polymorphic types.
PolymorphicTypes.Type - Annotation Interface in de.exlll.configlib: Indicates a subtype of a Polymorphic type.
PostProcess - Annotation Interface in de.exlll.configlib: Indicates that the annotated element should be post-processed.
properties() - Method in interface de.exlll.configlib.SerializerContext: Returns the ConfigurationProperties object in use when the serializer was selected.
property() - Element in annotation interface de.exlll.configlib.Polymorphic: Returns the name of the property that holds the type information.

R

read(InputStream) - Method in interface de.exlll.configlib.IOStreamConfigurationStore: Reads a configuration from the given input stream.

S

save(T, Path) - Method in interface de.exlll.configlib.FileConfigurationStore: Saves a configuration instance to the given file.
serialize(T1) - Method in interface de.exlll.configlib.Serializer: Serializes an element of type T1 into an element of type T2.
serializer() - Element in annotation interface de.exlll.configlib.SerializeWith: Returns the type of the serializer to be used.
Serializer<T1,T2> - Interface in de.exlll.configlib: Implementations of this interface convert instances of type T1 to a serializable type T2 and vice versa.
SerializerContext - Interface in de.exlll.configlib: Instances of this class provide contextual information for custom serializers.
SerializeWith - Annotation Interface in de.exlll.configlib: Indicates that the annotated configuration element or type should be serialized using an instance of the referenced serializer.
setFieldFilter(FieldFilter) - Method in class de.exlll.configlib.ConfigurationProperties.Builder: Sets the field filter.
setNameFormatter(NameFormatter) - Method in class de.exlll.configlib.ConfigurationProperties.Builder: Sets the name formatter.

T

toBuilder() - Method in class de.exlll.configlib.ConfigurationProperties: Creates a new builder and initializes it with values taken from this properties object.
toBuilder() - Method in class de.exlll.configlib.FileConfigurationProperties
type() - Method in interface de.exlll.configlib.ConfigurationElement: Returns the type of the element.
type() - Element in annotation interface de.exlll.configlib.PolymorphicTypes.Type: Returns the class of the subtype.

U

update(Path) - Method in interface de.exlll.configlib.FileConfigurationStore: Updates the configuration file.
UPPER_KEBAB_CASE - Enum constant in enum class de.exlll.configlib.NameFormatters: A NameFormatter that transforms camelCase to UPPER-KEBAB-CASE.
UPPER_UNDERSCORE - Enum constant in enum class de.exlll.configlib.NameFormatters: A NameFormatter that transforms camelCase to UPPER_UNDERSCORE.

V

value() - Element in annotation interface de.exlll.configlib.Comment: Returns the comments of the annotated configuration element.
value() - Element in annotation interface de.exlll.configlib.PolymorphicTypes: Returns (possibly only a subset of) the subtypes of the annotated type.
value(Object) - Method in interface de.exlll.configlib.ConfigurationElement: Given an instance of the configuration type which defines this element, returns the value the element is holding.
valueOf(String) - Static method in enum class de.exlll.configlib.NameFormatters: Returns the enum constant of this class with the specified name.
values() - Static method in enum class de.exlll.configlib.NameFormatters: Returns an array containing the constants of this enum class, in the order they are declared.

W

write(T, OutputStream) - Method in interface de.exlll.configlib.IOStreamConfigurationStore: Writes a configuration instance to the given output stream.

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