A B C D E F G H I L M N O P R S T U V W Y

A

AbstractLeafValueHandler - Class in ch.jalu.configme.beanmapper.leafvaluehandler

Common parent of simple leaf value handlers which only need the required type as Class in order to perform their conversion.

AbstractLeafValueHandler() - Constructor for class ch.jalu.configme.beanmapper.leafvaluehandler.AbstractLeafValueHandler

add(Property<?>) - Method in class ch.jalu.configme.configurationdata.PropertyListBuilder

Adds the property to the list builder.

addValueIntoMap(Map<String, Object>, String, Object) - Method in class ch.jalu.configme.resource.MapNormalizer

Adds the provided value into the given map, splitting the path into periods appropriately and keeping any intermediate nested maps which may already exist.

apply(String, T, PropertyType<K>) - Method in interface ch.jalu.configme.properties.PropertyBuilder.CreateFunction

areAllValuesValidInResource() - Method in interface ch.jalu.configme.configurationdata.ConfigurationData

Returns if the last call of ConfigurationData.initializeValues(ch.jalu.configme.resource.PropertyReader) had fully valid values in the resource for all known properties.

areAllValuesValidInResource() - Method in class ch.jalu.configme.configurationdata.ConfigurationDataImpl

ArrayProperty<T> - Class in ch.jalu.configme.properties

ArrayProperty(String, T[], PropertyType<T>, IntFunction<T[]>) - Constructor for class ch.jalu.configme.properties.ArrayProperty

Constructor.

arrayProperty(PropertyType<T>, IntFunction<T[]>) - Static method in class ch.jalu.configme.properties.PropertyInitializer

ArrayPropertyBuilder(PropertyType<T>, IntFunction<T[]>) - Constructor for class ch.jalu.configme.properties.PropertyBuilder.ArrayPropertyBuilder

B

BaseProperty<T> - Class in ch.jalu.configme.properties

Base implementation of Property.

BaseProperty(String, T) - Constructor for class ch.jalu.configme.properties.BaseProperty

Constructor.

BeanDescriptionFactory - Interface in ch.jalu.configme.beanmapper.propertydescription

Factory which analyzes a class and returns all writable properties.

BeanDescriptionFactoryImpl - Class in ch.jalu.configme.beanmapper.propertydescription

Creates all BeanPropertyDescription objects for a given class.

BeanDescriptionFactoryImpl() - Constructor for class ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

BeanProperty<T> - Class in ch.jalu.configme.properties

BeanProperty(Class<T>, String, T) - Constructor for class ch.jalu.configme.properties.BeanProperty

BeanProperty(Class<T>, String, T, Mapper) - Constructor for class ch.jalu.configme.properties.BeanProperty

BeanProperty(TypeInformation, String, T, Mapper) - Constructor for class ch.jalu.configme.properties.BeanProperty

Constructor.

BeanPropertyComments - Class in ch.jalu.configme.beanmapper.propertydescription

Contains the comments for a bean property, with a UUID if the comment should only be included once.

BeanPropertyComments(List<String>, UUID) - Constructor for class ch.jalu.configme.beanmapper.propertydescription.BeanPropertyComments

Constructor.

BeanPropertyDescription - Interface in ch.jalu.configme.beanmapper.propertydescription

Represents a property within a bean class, as used in MapperImpl.

BeanPropertyDescriptionImpl - Class in ch.jalu.configme.beanmapper.propertydescription

Default implementation of BeanPropertyDescription.

BeanPropertyDescriptionImpl(String, TypeInformation, Method, Method) - Constructor for class ch.jalu.configme.beanmapper.propertydescription.BeanPropertyDescriptionImpl

Deprecated.

BeanPropertyDescriptionImpl(String, TypeInformation, Method, Method, BeanPropertyComments) - Constructor for class ch.jalu.configme.beanmapper.propertydescription.BeanPropertyDescriptionImpl

Constructor.

BeanPropertyType<B> - Class in ch.jalu.configme.properties.types

BeanPropertyType(TypeInformation, Mapper) - Constructor for class ch.jalu.configme.properties.types.BeanPropertyType

BigNumberLeafValueHandler - Class in ch.jalu.configme.beanmapper.leafvaluehandler

Number handler for 'Big' types that have arbitrary precision (BigInteger, BigDecimal) and should be represented as strings in the config.

BigNumberLeafValueHandler() - Constructor for class ch.jalu.configme.beanmapper.leafvaluehandler.BigNumberLeafValueHandler

BOOLEAN - Static variable in class ch.jalu.configme.properties.inlinearray.StandardInlineArrayConverters

BOOLEAN - Static variable in class ch.jalu.configme.properties.types.PrimitivePropertyType

BooleanLeafValueHandler - Class in ch.jalu.configme.beanmapper.leafvaluehandler

Boolean leaf value handler.

BooleanLeafValueHandler() - Constructor for class ch.jalu.configme.beanmapper.leafvaluehandler.BooleanLeafValueHandler

BooleanProperty - Class in ch.jalu.configme.properties

Boolean property.

BooleanProperty(String, Boolean) - Constructor for class ch.jalu.configme.properties.BooleanProperty

build() - Method in class ch.jalu.configme.properties.PropertyBuilder.ArrayPropertyBuilder

build() - Method in class ch.jalu.configme.properties.PropertyBuilder

Creates a property with the configured details.

build() - Method in class ch.jalu.configme.properties.PropertyBuilder.InlineArrayPropertyBuilder

build() - Method in class ch.jalu.configme.properties.PropertyBuilder.ListPropertyBuilder

build() - Method in class ch.jalu.configme.properties.PropertyBuilder.MapPropertyBuilder

build() - Method in class ch.jalu.configme.properties.PropertyBuilder.SetPropertyBuilder

build() - Method in class ch.jalu.configme.properties.PropertyBuilder.TypeBasedPropertyBuilder

build() - Method in class ch.jalu.configme.resource.YamlFileResourceOptions.Builder

builder() - Static method in class ch.jalu.configme.resource.YamlFileResourceOptions

Builder() - Constructor for class ch.jalu.configme.resource.YamlFileResourceOptions.Builder

BYTE - Static variable in class ch.jalu.configme.properties.inlinearray.StandardInlineArrayConverters

BYTE - Static variable in class ch.jalu.configme.properties.types.PrimitivePropertyType

C

ch.jalu.configme - package ch.jalu.configme

ch.jalu.configme.beanmapper - package ch.jalu.configme.beanmapper

ch.jalu.configme.beanmapper.leafvaluehandler - package ch.jalu.configme.beanmapper.leafvaluehandler

ch.jalu.configme.beanmapper.propertydescription - package ch.jalu.configme.beanmapper.propertydescription

ch.jalu.configme.configurationdata - package ch.jalu.configme.configurationdata

ch.jalu.configme.exception - package ch.jalu.configme.exception

ch.jalu.configme.migration - package ch.jalu.configme.migration

ch.jalu.configme.migration.version - package ch.jalu.configme.migration.version

ch.jalu.configme.properties - package ch.jalu.configme.properties

ch.jalu.configme.properties.convertresult - package ch.jalu.configme.properties.convertresult

ch.jalu.configme.properties.inlinearray - package ch.jalu.configme.properties.inlinearray

ch.jalu.configme.properties.types - package ch.jalu.configme.properties.types

ch.jalu.configme.resource - package ch.jalu.configme.resource

ch.jalu.configme.resource.yaml - package ch.jalu.configme.resource.yaml

ch.jalu.configme.utils - package ch.jalu.configme.utils

charset(Charset) - Method in class ch.jalu.configme.resource.YamlFileResourceOptions.Builder

checkAndMigrate(PropertyReader, ConfigurationData) - Method in interface ch.jalu.configme.migration.MigrationService

Performs the migration, returning whether a migration has been performed or not.

checkAndMigrate(PropertyReader, ConfigurationData) - Method in class ch.jalu.configme.migration.PlainMigrationService

checkAndMigrate(PropertyReader, ConfigurationData) - Method in class ch.jalu.configme.migration.version.VersionMigrationService

collectAllProperties(Class<?>) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

Collects all properties available on the given class.

collectClassAndAllParents(Class<?>) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

Returns a list of the class's parents, including the given class itself, with the top-most parent coming first.

collectComments(Object, String, ConfigurationData, int) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilderImpl

Creates comments based on all possible sources (number of empty lines, configuration data, ValueWithComments) and returns them as SnakeYAML comment lines.

collectData(Iterable<Class<? extends SettingsHolder>>) - Method in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

Collects property data and comment info from the given class and creates a configuration data instance with it.

collectProperties(Class<?>) - Method in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

Registers all property fields of the given class to this instance's property list builder.

collectSectionComments(Class<? extends SettingsHolder>) - Method in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

CombiningLeafValueHandler - Class in ch.jalu.configme.beanmapper.leafvaluehandler

Implementation of LeafValueHandler which takes various implementations thereof and returns the first non-null result of the underlying leaf value handlers.

CombiningLeafValueHandler(LeafValueHandler...) - Constructor for class ch.jalu.configme.beanmapper.leafvaluehandler.CombiningLeafValueHandler

Constructor.

CombiningLeafValueHandler(Collection<LeafValueHandler>) - Constructor for class ch.jalu.configme.beanmapper.leafvaluehandler.CombiningLeafValueHandler

Constructor.

Comment - Annotation Type in ch.jalu.configme

Comment for properties which are also included in the configuration file upon saving.

CommentsConfiguration - Class in ch.jalu.configme.configurationdata

Allows to register comments (intended via SettingsHolder.registerComments(ch.jalu.configme.configurationdata.CommentsConfiguration)).

CommentsConfiguration() - Constructor for class ch.jalu.configme.configurationdata.CommentsConfiguration

Constructor.

CommentsConfiguration(Map<String, List<String>>) - Constructor for class ch.jalu.configme.configurationdata.CommentsConfiguration

Constructor.

commentsConfiguration - Variable in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

ConfigMeException - Exception in ch.jalu.configme.exception

ConfigMe exception.

ConfigMeException(String) - Constructor for exception ch.jalu.configme.exception.ConfigMeException

ConfigMeException(String, Throwable) - Constructor for exception ch.jalu.configme.exception.ConfigMeException

ConfigMeMapperException - Exception in ch.jalu.configme.beanmapper

Exception during a bean mapping process.

ConfigMeMapperException(String) - Constructor for exception ch.jalu.configme.beanmapper.ConfigMeMapperException

Constructor.

ConfigMeMapperException(String, Throwable) - Constructor for exception ch.jalu.configme.beanmapper.ConfigMeMapperException

Constructor.

ConfigMeMapperException(MappingContext, String) - Constructor for exception ch.jalu.configme.beanmapper.ConfigMeMapperException

Constructor.

ConfigMeMapperException(MappingContext, String, Throwable) - Constructor for exception ch.jalu.configme.beanmapper.ConfigMeMapperException

Constructor.

ConfigurationData - Interface in ch.jalu.configme.configurationdata

Manages configuration data: knows all available properties keeps all comments manages the values associated with the properties Create instances with ConfigurationDataBuilder.

configurationData(Class<? extends SettingsHolder>...) - Method in class ch.jalu.configme.SettingsManagerBuilder

Sets up configuration data with the input of the given settings holder classes.

configurationData(ConfigurationData) - Method in class ch.jalu.configme.SettingsManagerBuilder

Sets the provided configuration data to the builder.

ConfigurationDataBuilder - Class in ch.jalu.configme.configurationdata

Utility class responsible for retrieving all Property fields from SettingsHolder implementations via reflection.

ConfigurationDataBuilder() - Constructor for class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

ConfigurationDataImpl - Class in ch.jalu.configme.configurationdata

Contains information about the available properties and their associated comments.

ConfigurationDataImpl(List<? extends Property<?>>, Map<String, List<String>>) - Constructor for class ch.jalu.configme.configurationdata.ConfigurationDataImpl

Constructor.

contains(String) - Method in interface ch.jalu.configme.resource.PropertyReader

Returns whether a value is present for the given path.

contains(String) - Method in class ch.jalu.configme.resource.YamlFileReader

convert(TypeInformation, Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.AbstractLeafValueHandler

convert(Class<?>, Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.AbstractLeafValueHandler

convert(Class<?>, Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.BigNumberLeafValueHandler

convert(Class<?>, Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.BooleanLeafValueHandler

convert(TypeInformation, Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.CombiningLeafValueHandler

convert(Class<?>, Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.EnumLeafValueHandler

convert(TypeInformation, Object) - Method in interface ch.jalu.configme.beanmapper.leafvaluehandler.LeafValueHandler

Converts the given value to the given class, if possible.

convert(Class<?>, Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.NumberLeafValueHandler

convert(Class<?>, Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.ObjectLeafValueHandler

convert(Class<?>, Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.StringLeafValueHandler

convert(PropertyDescriptor) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

Converts a PropertyDescriptor to a BeanPropertyDescription object.

convert(String) - Method in class ch.jalu.configme.properties.inlinearray.StandardInlineArrayConverters

Converts from the given String to the converter's type, if possible.

convert(Object, ConvertErrorRecorder) - Method in class ch.jalu.configme.properties.types.BeanPropertyType

convert(Object, ConvertErrorRecorder) - Method in class ch.jalu.configme.properties.types.EnumPropertyType

convert(Object, ConvertErrorRecorder) - Method in class ch.jalu.configme.properties.types.PrimitivePropertyType

convert(Object, ConvertErrorRecorder) - Method in interface ch.jalu.configme.properties.types.PropertyType

Converts the given object (typically read from a property resource) to the given type, if possible.

ConvertErrorRecorder - Class in ch.jalu.configme.properties.convertresult

Records errors during the conversion of a property to its Java value.

ConvertErrorRecorder() - Constructor for class ch.jalu.configme.properties.convertresult.ConvertErrorRecorder

convertToBean(Object, TypeInformation, ConvertErrorRecorder) - Method in interface ch.jalu.configme.beanmapper.Mapper

Creates an object of the given type from the given value.

convertToBean(Object, Class<T>, ConvertErrorRecorder) - Method in interface ch.jalu.configme.beanmapper.Mapper

Converts the given value to an object of the given class, if possible.

convertToBean(Object, TypeInformation, ConvertErrorRecorder) - Method in class ch.jalu.configme.beanmapper.MapperImpl

convertToNode(SnakeYamlNodeBuilder) - Method in interface ch.jalu.configme.resource.yaml.SnakeYamlNodeContainer

Converts this container and its sub-containers, recursively, to a SnakeYAML node that represents all SnakeYAML nodes held by the containers.

convertToNode(SnakeYamlNodeBuilder) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeContainerImpl

convertValueForType(MappingContext, Object) - Method in class ch.jalu.configme.beanmapper.MapperImpl

Main method for converting a value to another type.

create() - Method in class ch.jalu.configme.configurationdata.PropertyListBuilder

Creates a list of properties that have been added, by insertion order but grouped by path parents (see class JavaDoc).

create() - Method in class ch.jalu.configme.SettingsManagerBuilder

Creates a settings manager instance.

createAndAddYamlNode(Object, String, List<PropertyPathTraverser.PathElement>, SnakeYamlNodeContainer, ConfigurationData, SnakeYamlNodeBuilder) - Method in class ch.jalu.configme.resource.YamlFileResource

Creates a YAML node for the export value and stores it, along with any comments for intermediate paths that have not been visited yet.

createBean(MappingContext, Object) - Method in class ch.jalu.configme.beanmapper.MapperImpl

Converts the provided value to the requested JavaBeans class if possible.

createBeanMatchingType(MappingContext) - Method in class ch.jalu.configme.beanmapper.MapperImpl

Creates an object matching the given type information.

createBooleanNode(boolean) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilderImpl

createChild(String, TypeInformation) - Method in interface ch.jalu.configme.beanmapper.MappingContext

Creates a child context with the given path addition ("name") and type information.

createChild(String, TypeInformation) - Method in class ch.jalu.configme.beanmapper.MappingContextImpl

createCollection(MappingContext, Object) - Method in class ch.jalu.configme.beanmapper.MapperImpl

Handles the creation of Collection properties.

createCollectionMatchingType(MappingContext) - Method in class ch.jalu.configme.beanmapper.MapperImpl

Creates a Collection of a type which can be assigned to the provided type.

createCommentLines(String) - Method in interface ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilder

Creates SnakeYAML CommentLine objects to represent the given comment.

createCommentLines(String) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilderImpl

createConfiguration(Class<? extends SettingsHolder>...) - Static method in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

Collects all properties and comment data from the provided classes.

createConfiguration(Iterable<Class<? extends SettingsHolder>>) - Static method in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

Collects all properties and comment data from the provided classes.

createConfiguration(List<? extends Property<?>>) - Static method in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

createConfiguration(List<? extends Property<?>>, CommentsConfiguration) - Static method in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

createConfigurationData(Iterable<Class<? extends SettingsHolder>>) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

createDescription() - Method in interface ch.jalu.configme.beanmapper.MappingContext

createDescription() - Method in class ch.jalu.configme.beanmapper.MappingContextImpl

createExportValueForSpecialTypes(Object, Set<UUID>) - Method in class ch.jalu.configme.beanmapper.MapperImpl

Handles values of types which need special handling (such as Optional).

createFieldNameOrderMap(Class<?>) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

Creates a map of index (encounter number) by field name for all fields of the given class, including its superclasses.

createFileIfNotExists(Path) - Static method in class ch.jalu.configme.utils.Utils

Attempts to create the given Path (as file) if it doesn't exist.

createFunction(PropertyBuilder.CreateFunction<T, T>) - Method in class ch.jalu.configme.properties.PropertyBuilder.TypeBasedPropertyBuilder

createKeyNode(String) - Method in interface ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilder

Creates a SnakeYAML string node for a key value (e.g.

createKeyNode(String) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilderImpl

createMap(MappingContext, Object) - Method in class ch.jalu.configme.beanmapper.MapperImpl

Handles the creation of a Map property.

createMapMatchingType(MappingContext) - Method in class ch.jalu.configme.beanmapper.MapperImpl

Creates a Map of a type which can be assigned to the provided type.

createMapNode(Map<String, ?>, String, ConfigurationData) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilderImpl

Creates a SnakeYAML node representing a map (collection of key-value pairs).

createNewYaml() - Method in class ch.jalu.configme.resource.YamlFileResource

Creates a new SnakeYAML object with the appropriate options.

createNodeBuilder() - Method in class ch.jalu.configme.resource.YamlFileResource

createNodeContainerForRoot(List<String>) - Method in class ch.jalu.configme.resource.YamlFileResource

createNormalizedMapIfNeeded(Object) - Method in class ch.jalu.configme.resource.MapNormalizer

Processes the given value if it is a Map and returns an Optional with a new Map if the input value is not in its "normalized form".

createNumberNode(Number) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilderImpl

createOptional(MappingContext, Object) - Method in class ch.jalu.configme.beanmapper.MapperImpl

createReader() - Method in interface ch.jalu.configme.resource.PropertyResource

Creates a reader to access the values in the medium (typically a file).

createReader() - Method in class ch.jalu.configme.resource.YamlFileResource

createRoot(TypeInformation, ConvertErrorRecorder) - Static method in class ch.jalu.configme.beanmapper.MappingContextImpl

Creates an initial context (used at the start of a mapping process).

createRootMappingContext(TypeInformation, ConvertErrorRecorder) - Method in class ch.jalu.configme.beanmapper.MapperImpl

createRootNode(List<NodeTuple>) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeContainerImpl

createSequenceNode(Stream<?>, String, ConfigurationData) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilderImpl

Creates a SnakeYAML node representing a sequence of the entries in the stream.

createSettingsHolderInstance(Class<T>) - Method in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

Creates an instance of the given settings holder class.

createStringNode(String) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilderImpl

createTypeInfo(PropertyDescriptor) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

createValidLengthPredicate(Integer, Integer) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

Creates a predicate based on input min length and max length that evaluates successfully for a string if its length is within the given bounds: minLength <= length <= maxLength.

createYamlNode(Object, String, ConfigurationData, int) - Method in interface ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilder

Creates a SnakeYAML node representing the given value.

createYamlNode(Object, String, ConfigurationData, int) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilderImpl

D

defaultEntry(String, T) - Method in class ch.jalu.configme.properties.PropertyBuilder.MapPropertyBuilder

DefaultMapper - Class in ch.jalu.configme.beanmapper

Provides the Mapper instance which is used by default.

defaultValue(T...) - Method in class ch.jalu.configme.properties.PropertyBuilder.ArrayPropertyBuilder

defaultValue(T) - Method in class ch.jalu.configme.properties.PropertyBuilder

Sets the default of the property.

defaultValue(T...) - Method in class ch.jalu.configme.properties.PropertyBuilder.InlineArrayPropertyBuilder

defaultValue(T...) - Method in class ch.jalu.configme.properties.PropertyBuilder.ListPropertyBuilder

defaultValue(T...) - Method in class ch.jalu.configme.properties.PropertyBuilder.SetPropertyBuilder

determineValue(PropertyReader) - Method in class ch.jalu.configme.properties.BaseProperty

determineValue(PropertyReader) - Method in class ch.jalu.configme.properties.OptionalProperty

determineValue(PropertyReader) - Method in interface ch.jalu.configme.properties.Property

Returns the value, based on the given reader, which should be used for this property.

DOUBLE - Static variable in class ch.jalu.configme.properties.inlinearray.StandardInlineArrayConverters

DOUBLE - Static variable in class ch.jalu.configme.properties.types.PrimitivePropertyType

DoubleProperty - Class in ch.jalu.configme.properties

Double property.

DoubleProperty(String, double) - Constructor for class ch.jalu.configme.properties.DoubleProperty

E

EMPTY - Static variable in class ch.jalu.configme.beanmapper.propertydescription.BeanPropertyComments

Instance which can be used if there are no comments to add.

EnumLeafValueHandler - Class in ch.jalu.configme.beanmapper.leafvaluehandler

Enum handler.

EnumLeafValueHandler() - Constructor for class ch.jalu.configme.beanmapper.leafvaluehandler.EnumLeafValueHandler

EnumProperty<E extends Enum<E>> - Class in ch.jalu.configme.properties

Enum property.

EnumProperty(Class<E>, String, E) - Constructor for class ch.jalu.configme.properties.EnumProperty

EnumPropertyType<E extends Enum<E>> - Class in ch.jalu.configme.properties.types

EnumPropertyType(Class<E>) - Constructor for class ch.jalu.configme.properties.types.EnumPropertyType

equals(Object) - Method in class ch.jalu.configme.utils.TypeInformation

ExportName - Annotation Type in ch.jalu.configme.beanmapper

Annotation placed on a field, getter or setter method to indicate that it should be loaded and written to a property resource with a different name.

exportProperties(ConfigurationData) - Method in interface ch.jalu.configme.resource.PropertyResource

Exports the provided configuration data to the medium (typically a file).

exportProperties(ConfigurationData) - Method in class ch.jalu.configme.resource.YamlFileResource

F

findFieldsToProcess(Class<?>) - Method in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

Returns all fields of the class which should be considered as potential Property definitions.

FLOAT - Static variable in class ch.jalu.configme.properties.inlinearray.StandardInlineArrayConverters

FLOAT - Static variable in class ch.jalu.configme.properties.types.PrimitivePropertyType

FloatProperty - Class in ch.jalu.configme.properties

Float property.

FloatProperty(String, float) - Constructor for class ch.jalu.configme.properties.FloatProperty

fromField(Field) - Static method in class ch.jalu.configme.utils.TypeInformation

Creates a new TypeInformation instance based on the given field's type.

fromNumber(Class<?>, Number) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.BigNumberLeafValueHandler

Creates a BigInteger or BigDecimal value from the given number value, if possible.

fromString(Class<?>, String) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.BigNumberLeafValueHandler

Creates a BigInteger or BigDecimal value from the given string value, if possible.

fromString(String) - Method in interface ch.jalu.configme.properties.inlinearray.InlineArrayConverter

Converts from the String to an array of the converter's type.

fromString(String) - Method in class ch.jalu.configme.properties.inlinearray.StandardInlineArrayConverters

fromVersion() - Method in interface ch.jalu.configme.migration.version.VersionMigration

G

gatherExpectedEnumNames(Class<? extends Enum<?>>) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

getAllComments() - Method in class ch.jalu.configme.configurationdata.CommentsConfiguration

Returns a read-only view of the map with all comments.

getAllComments() - Method in interface ch.jalu.configme.configurationdata.ConfigurationData

Returns all comments registered to this configuration data.

getAllComments() - Method in class ch.jalu.configme.configurationdata.ConfigurationDataImpl

getAllFields(Class<?>) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

Returns all fields of the class, including all fields of parent classes, recursively.

getAllProperties(Class<?>) - Method in interface ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactory

Returns all properties on the given class which should be considered while creating a bean of the given type.

getAllProperties(Class<?>) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

Returns all properties of the given bean class for which there exists a getter and setter.

getBeanDescriptionFactory() - Method in class ch.jalu.configme.beanmapper.MapperImpl

getBoolean(String) - Method in interface ch.jalu.configme.resource.PropertyReader

Returns the value of the given path as a boolean if available.

getBoolean(String) - Method in class ch.jalu.configme.resource.YamlFileReader

getCharset() - Method in class ch.jalu.configme.resource.YamlFileResourceOptions

getChildKeys(String) - Method in interface ch.jalu.configme.resource.PropertyReader

Returns the direct children of the given path which are available in the file.

getChildKeys(String) - Method in class ch.jalu.configme.resource.YamlFileReader

getComments(Field) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

Returns the comments that are defined on the property.

getComments() - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanPropertyComments

getComments() - Method in interface ch.jalu.configme.beanmapper.propertydescription.BeanPropertyDescription

getComments() - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanPropertyDescriptionImpl

getComments() - Method in class ch.jalu.configme.properties.convertresult.ValueWithComments

getComments() - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeContainerImpl

getCommentsForPathElement(ConfigurationData, PropertyPathTraverser.PathElement) - Method in class ch.jalu.configme.resource.YamlFileResource

getCommentsForSection(String) - Method in interface ch.jalu.configme.configurationdata.ConfigurationData

Returns the comments associated with the given path.

getCommentsForSection(String) - Method in class ch.jalu.configme.configurationdata.ConfigurationDataImpl

getConfigurationData() - Method in class ch.jalu.configme.SettingsManagerImpl

getDefaultLeafValueHandler() - Static method in class ch.jalu.configme.beanmapper.leafvaluehandler.StandardLeafValueHandlers

Returns the default leaf value handler used in ConfigMe.

getDefaultValue() - Method in class ch.jalu.configme.properties.BaseProperty

getDefaultValue() - Method in class ch.jalu.configme.properties.OptionalProperty

getDefaultValue() - Method in interface ch.jalu.configme.properties.Property

Returns the default value of this property.

getDefaultValue() - Method in class ch.jalu.configme.properties.PropertyBuilder

getDouble(String) - Method in interface ch.jalu.configme.resource.PropertyReader

Returns the value of the given path as a double if available.

getDouble(String) - Method in class ch.jalu.configme.resource.YamlFileReader

getEnumTypeOfProperty(Property<?>) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

Returns the type of the given property if it is an enum, otherwise null.

getFile() - Method in class ch.jalu.configme.resource.YamlFileReader

Deprecated.

getFile() - Method in class ch.jalu.configme.resource.YamlFileResource

Deprecated.

getFromReader(PropertyReader, ConvertErrorRecorder) - Method in class ch.jalu.configme.properties.ArrayProperty

getFromReader(PropertyReader, ConvertErrorRecorder) - Method in class ch.jalu.configme.properties.BaseProperty

Constructs the value of the property from the property reader.

getFromReader(PropertyReader, ConvertErrorRecorder) - Method in class ch.jalu.configme.properties.InlineArrayProperty

getFromReader(PropertyReader, ConvertErrorRecorder) - Method in class ch.jalu.configme.properties.ListProperty

getFromReader(PropertyReader, ConvertErrorRecorder) - Method in class ch.jalu.configme.properties.MapProperty

getFromReader(PropertyReader, ConvertErrorRecorder) - Method in class ch.jalu.configme.properties.RegexProperty

getFromReader(PropertyReader, ConvertErrorRecorder) - Method in class ch.jalu.configme.properties.SetProperty

getFromReader(PropertyReader, ConvertErrorRecorder) - Method in class ch.jalu.configme.properties.TypeBasedProperty

getFullPath() - Method in class ch.jalu.configme.resource.PropertyPathTraverser.PathElement

getGenericType(int) - Method in class ch.jalu.configme.utils.TypeInformation

"Unwraps" the type and returns the generic type information for the given index, provided the wrapped type contains generic information.

getGenericTypeAsClass(int) - Method in class ch.jalu.configme.utils.TypeInformation

"Unwraps" the type and returns the generic type information for the given index as Class object, provided the wrapped type contains generic information.

getGenericTypeInfoOrFail(int) - Method in interface ch.jalu.configme.beanmapper.MappingContext

Convenience method: gets the generic type info for the given index and ensures that the generic type information exists and that it can be converted into a safe-to-write class.

getHandlers() - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.CombiningLeafValueHandler

getIndentationLevel() - Method in class ch.jalu.configme.resource.PropertyPathTraverser.PathElement

getIndentationSize() - Method in class ch.jalu.configme.resource.YamlFileResourceOptions

getIndentFunction() - Method in class ch.jalu.configme.resource.YamlFileResourceOptions

getInstance() - Static method in class ch.jalu.configme.beanmapper.DefaultMapper

getInt(String) - Method in interface ch.jalu.configme.resource.PropertyReader

Returns the value of the given path as an integer if available.

getInt(String) - Method in class ch.jalu.configme.resource.YamlFileReader

getKeys(boolean) - Method in interface ch.jalu.configme.resource.PropertyReader

Returns the keys available in the file.

getKeys(boolean) - Method in class ch.jalu.configme.resource.YamlFileReader

getLeafValueHandler() - Method in class ch.jalu.configme.beanmapper.MapperImpl

getList(String) - Method in interface ch.jalu.configme.resource.PropertyReader

Returns the value of the given path as a list if available.

getList(String) - Method in class ch.jalu.configme.resource.YamlFileReader

getMapBeforeLastElement(String[]) - Method in class ch.jalu.configme.configurationdata.PropertyListBuilder

Returns the nested map for the given path parts in which a property can be saved (for the last element in the path parts).

getMigrationsByStartVersion() - Method in class ch.jalu.configme.migration.version.VersionMigrationService

getMigrationService() - Method in class ch.jalu.configme.SettingsManagerImpl

getName() - Method in interface ch.jalu.configme.beanmapper.propertydescription.BeanPropertyDescription

getName() - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanPropertyDescriptionImpl

getName() - Method in class ch.jalu.configme.resource.PropertyPathTraverser.PathElement

getNumberOfEmptyLinesBefore(PropertyPathTraverser.PathElement) - Method in class ch.jalu.configme.resource.YamlFileResourceOptions

getObject(String) - Method in interface ch.jalu.configme.resource.PropertyReader

Returns the object at the given path, or null if absent.

getObject(String) - Method in class ch.jalu.configme.resource.YamlFileReader

getOptions() - Method in class ch.jalu.configme.resource.YamlFileResource

getOrCreateChildContainer(String, Supplier<List<String>>) - Method in interface ch.jalu.configme.resource.yaml.SnakeYamlNodeContainer

Returns the existing container for the given name, or creates one and registers the comments as returned by the supplier.

getOrCreateChildContainer(String, Supplier<List<String>>) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeContainerImpl

getOrInsertMap(Map<String, Object>, String) - Method in class ch.jalu.configme.resource.MapNormalizer

Returns the nested map in the given parentMap at the given path, inserting one if none is yet present.

getPath() - Method in class ch.jalu.configme.properties.BaseProperty

getPath() - Method in class ch.jalu.configme.properties.OptionalProperty

getPath() - Method in interface ch.jalu.configme.properties.Property

getPath() - Method in class ch.jalu.configme.properties.PropertyBuilder

getPath() - Method in class ch.jalu.configme.resource.YamlFileReader

getPath() - Method in class ch.jalu.configme.resource.YamlFileResource

getPathElements(String) - Method in class ch.jalu.configme.resource.PropertyPathTraverser

Returns all path elements of the given path.

getProperties() - Method in interface ch.jalu.configme.configurationdata.ConfigurationData

Returns all known properties.

getProperties() - Method in class ch.jalu.configme.configurationdata.ConfigurationDataImpl

getProperty(Property<T>) - Method in interface ch.jalu.configme.SettingsManager

Gets the given property from the configuration.

getProperty(Property<T>) - Method in class ch.jalu.configme.SettingsManagerImpl

Gets the given property from the configuration.

getPropertyField(Field) - Method in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

Returns the given field's value if it is a static Property.

getPropertyName(PropertyDescriptor, Field) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

Returns the name which is used in the export files for the given property descriptor.

getPropertyResource() - Method in class ch.jalu.configme.SettingsManagerImpl

getRoot() - Method in class ch.jalu.configme.resource.YamlFileReader

Deprecated.

use getObject("") instead

getRootEntries() - Method in class ch.jalu.configme.configurationdata.PropertyListBuilder

getRootValueNode() - Method in interface ch.jalu.configme.resource.yaml.SnakeYamlNodeContainer

Returns the SnakeYAML node at the root path (empty string).

getRootValueNode() - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeContainerImpl

getSafeToReadClass() - Method in class ch.jalu.configme.utils.TypeInformation

Returns a Class object of the wrapped type which is safe for reading.

getSafeToWriteClass() - Method in class ch.jalu.configme.utils.TypeInformation

Returns a Class object of the wrapped type which is safe for writing to.

getString(String) - Method in interface ch.jalu.configme.resource.PropertyReader

Returns the value of the given path as a String if available.

getString(String) - Method in class ch.jalu.configme.resource.YamlFileReader

getType() - Method in class ch.jalu.configme.properties.PropertyBuilder

getType() - Method in class ch.jalu.configme.properties.TypeBasedProperty

getType() - Method in class ch.jalu.configme.utils.TypeInformation

getTypedObject(String, Class<T>) - Method in class ch.jalu.configme.resource.YamlFileReader

Gets the object at the given path and safely casts it to the given class's type.

getTypeInformation() - Method in interface ch.jalu.configme.beanmapper.MappingContext

getTypeInformation() - Method in class ch.jalu.configme.beanmapper.MappingContextImpl

getTypeInformation() - Method in interface ch.jalu.configme.beanmapper.propertydescription.BeanPropertyDescription

getTypeInformation() - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanPropertyDescriptionImpl

getUniqueCommentId() - Method in class ch.jalu.configme.properties.convertresult.ValueWithComments

getUsedUniqueCommentIds() - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilderImpl

getUuid() - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanPropertyComments

UUID to identify this comment.

getValue(Object) - Method in interface ch.jalu.configme.beanmapper.propertydescription.BeanPropertyDescription

Returns the value of the property for the given bean.

getValue(Object) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanPropertyDescriptionImpl

Returns the value of the property for the given bean.

getValue(Property<T>) - Method in interface ch.jalu.configme.configurationdata.ConfigurationData

Returns the value associated with the given property.

getValue(Property<T>) - Method in class ch.jalu.configme.configurationdata.ConfigurationDataImpl

getValue() - Method in class ch.jalu.configme.properties.convertresult.PropertyValue

getValue() - Method in class ch.jalu.configme.properties.convertresult.ValueWithComments

getValues() - Method in class ch.jalu.configme.configurationdata.ConfigurationDataImpl

getValues() - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeContainerImpl

getVersionProperty() - Method in class ch.jalu.configme.migration.version.VersionMigrationService

getWritableProperties(Class<?>) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

Returns all properties of the given class that are writable (all bean properties with an associated read and write method).

getYamlObject() - Method in class ch.jalu.configme.resource.YamlFileResource

Returns the YAML instance with which values are converted to YAML.

H

handleSpecialTypes(MappingContext, Object) - Method in class ch.jalu.configme.beanmapper.MapperImpl

Handles special types in the bean mapping process which require special handling.

hashCode() - Method in class ch.jalu.configme.utils.TypeInformation

hasNonEmptyComment(List<String>) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

hasValidConstructorSetup(Class<? extends SettingsHolder>) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

I

indentationSize(int) - Method in class ch.jalu.configme.resource.YamlFileResourceOptions.Builder

initializeValues(PropertyReader) - Method in interface ch.jalu.configme.configurationdata.ConfigurationData

Initializes the values of all known properties based on the provided reader.

initializeValues(PropertyReader) - Method in class ch.jalu.configme.configurationdata.ConfigurationDataImpl

InlineArrayConverter<T> - Interface in ch.jalu.configme.properties.inlinearray

Converter from a simple String value to an array of multiple values.

InlineArrayProperty<T> - Class in ch.jalu.configme.properties

Array property which reads and stores its value as one String in which the elements are separated by a delimiter.

InlineArrayProperty(String, T[], InlineArrayConverter<T>) - Constructor for class ch.jalu.configme.properties.InlineArrayProperty

Constructor.

inlineArrayProperty(InlineArrayConverter<T>) - Static method in class ch.jalu.configme.properties.PropertyInitializer

InlineArrayPropertyBuilder(InlineArrayConverter<T>) - Constructor for class ch.jalu.configme.properties.PropertyBuilder.InlineArrayPropertyBuilder

INTEGER - Static variable in class ch.jalu.configme.properties.inlinearray.StandardInlineArrayConverters

INTEGER - Static variable in class ch.jalu.configme.properties.types.PrimitivePropertyType

IntegerProperty - Class in ch.jalu.configme.properties

Integer property.

IntegerProperty(String, Integer) - Constructor for class ch.jalu.configme.properties.IntegerProperty

isEndOfPath() - Method in class ch.jalu.configme.resource.PropertyPathTraverser.PathElement

Returns whether this path element represents the final part of a path, indicating that it is associated with a property.

isFirstElement() - Method in class ch.jalu.configme.resource.PropertyPathTraverser.PathElement

isFirstOfGroup() - Method in class ch.jalu.configme.resource.PropertyPathTraverser.PathElement

Returns if this path element is the first new path element of a property.

isFullyValid() - Method in class ch.jalu.configme.properties.convertresult.ConvertErrorRecorder

Returns whether the value that was returned from the property or property type was fully valid and therefore doesn't need a rewrite.

isKeyInvalid(Object) - Method in class ch.jalu.configme.resource.MapNormalizer

isValidConstantField(Field) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

isValidInResource() - Method in class ch.jalu.configme.properties.convertresult.PropertyValue

Returns true if the data in the resource is fully valid for creating the value of the property.

isValidInResource(PropertyReader) - Method in interface ch.jalu.configme.properties.Property

Convenience method to check whether the property is present in the given reader and a valid representation of the property type.

isValidValue(T) - Method in class ch.jalu.configme.properties.BaseProperty

isValidValue(Optional<T>) - Method in class ch.jalu.configme.properties.OptionalProperty

isValidValue(T) - Method in interface ch.jalu.configme.properties.Property

Returns whether the value can be associated to the given property, i.e.

L

LeafValueHandler - Interface in ch.jalu.configme.beanmapper.leafvaluehandler

A leaf value handler is used in MapperImpl to convert "simple" values from their read values to the desired type.

ListProperty<T> - Class in ch.jalu.configme.properties

List property of a configurable type.

ListProperty(String, PropertyType<T>, T...) - Constructor for class ch.jalu.configme.properties.ListProperty

Constructor.

ListProperty(String, PropertyType<T>, List<T>) - Constructor for class ch.jalu.configme.properties.ListProperty

Constructor.

listProperty(PropertyType<T>) - Static method in class ch.jalu.configme.properties.PropertyInitializer

ListPropertyBuilder(PropertyType<T>) - Constructor for class ch.jalu.configme.properties.PropertyBuilder.ListPropertyBuilder

loadFile(boolean) - Method in class ch.jalu.configme.resource.YamlFileReader

Loads the values of the file.

loadFromResourceAndValidate() - Method in class ch.jalu.configme.SettingsManagerImpl

Reads the configuration file and executes the migration service (if present).

LONG - Static variable in class ch.jalu.configme.properties.inlinearray.StandardInlineArrayConverters

LONG - Static variable in class ch.jalu.configme.properties.types.PrimitivePropertyType

LongProperty - Class in ch.jalu.configme.properties

Long property.

LongProperty(String, Long) - Constructor for class ch.jalu.configme.properties.LongProperty

LOWERCASE_STRING - Static variable in class ch.jalu.configme.properties.types.PrimitivePropertyType

LowercaseStringSetProperty - Class in ch.jalu.configme.properties

Property whose value is a String set all in lowercase.

LowercaseStringSetProperty(String, String...) - Constructor for class ch.jalu.configme.properties.LowercaseStringSetProperty

Constructor.

LowercaseStringSetProperty(String, Collection<String>) - Constructor for class ch.jalu.configme.properties.LowercaseStringSetProperty

Constructor.

M

MapNormalizer - Class in ch.jalu.configme.resource

Normalizes the keys of maps, splitting compound keys and ensuring that all keys are Strings.

MapNormalizer(boolean) - Constructor for class ch.jalu.configme.resource.MapNormalizer

Constructor.

Mapper - Interface in ch.jalu.configme.beanmapper

Creates JavaBeans based on the values coming from a property reader.

MapperImpl - Class in ch.jalu.configme.beanmapper

Implementation of Mapper.

MapperImpl() - Constructor for class ch.jalu.configme.beanmapper.MapperImpl

MapperImpl(BeanDescriptionFactory, LeafValueHandler) - Constructor for class ch.jalu.configme.beanmapper.MapperImpl

MappingContext - Interface in ch.jalu.configme.beanmapper

Holds necessary information for a certain value that is being mapped in the bean mapper.

MappingContextImpl - Class in ch.jalu.configme.beanmapper

Standard implementation of MappingContext.

MappingContextImpl(String, TypeInformation, ConvertErrorRecorder) - Constructor for class ch.jalu.configme.beanmapper.MappingContextImpl

MapProperty<V> - Class in ch.jalu.configme.properties

Property for an immutable map whose keys is of type String and whose values can be configured.

MapProperty(String, Map<String, V>, PropertyType<V>) - Constructor for class ch.jalu.configme.properties.MapProperty

Constructor.

mapProperty(PropertyType<T>) - Static method in class ch.jalu.configme.properties.PropertyInitializer

MapPropertyBuilder(PropertyType<T>) - Constructor for class ch.jalu.configme.properties.PropertyBuilder.MapPropertyBuilder

matches(String, SettingsManager) - Method in class ch.jalu.configme.properties.RegexProperty

Convenience method to evaluate whether the pattern set for this property matches the provided value.

migrate(PropertyReader, ConfigurationData) - Method in interface ch.jalu.configme.migration.version.VersionMigration

Migrates the configuration.

MIGRATION_REQUIRED - Static variable in interface ch.jalu.configme.migration.MigrationService

Constant for the return value of MigrationService.checkAndMigrate(ch.jalu.configme.resource.PropertyReader, ch.jalu.configme.configurationdata.ConfigurationData), indicating that a migration has been performed.

MigrationService - Interface in ch.jalu.configme.migration

The migration service is called when the settings manager is instantiated.

migrationService(MigrationService) - Method in class ch.jalu.configme.SettingsManagerBuilder

Sets the given migration service to the builder.

MigrationUtils - Class in ch.jalu.configme.utils

Migration utils.

moveProperty(Property<T>, Property<T>, PropertyReader, ConfigurationData) - Static method in class ch.jalu.configme.utils.MigrationUtils

Utility method: moves the value of an old property to a new property.

N

newBeanProperty(Class<B>, String, B) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new bean property.

newListProperty(String, String...) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new String list property.

newListProperty(String, List<String>) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new String list property.

newLowercaseStringSetProperty(String, String...) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new String set property where all values are lowercase.

newLowercaseStringSetProperty(String, Collection<String>) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new String set property where all values are lowercase.

newProperty(String, boolean) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new boolean property.

newProperty(String, short) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new short property.

newProperty(String, int) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new integer property.

newProperty(String, long) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new long property.

newProperty(String, float) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new float property.

newProperty(String, double) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new double property.

newProperty(String, String) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new String property.

newProperty(Class<E>, String, E) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new enum property.

newRegexProperty(String, String) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new regex pattern property.

newRegexProperty(String, Pattern) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new regex pattern property.

newSetProperty(String, String...) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new String set property.

newSetProperty(String, Set<String>) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new String set property.

NO_MIGRATION_NEEDED - Static variable in interface ch.jalu.configme.migration.MigrationService

Constant for the return value of MigrationService.checkAndMigrate(ch.jalu.configme.resource.PropertyReader, ch.jalu.configme.configurationdata.ConfigurationData), indicating that no migration was needed.

normalizeMap(Map<Object, Object>) - Method in class ch.jalu.configme.resource.MapNormalizer

Normalizes the raw map read from a property resource for further use in a property reader.

normalizeMap(Map<Object, Object>, boolean) - Method in class ch.jalu.configme.resource.YamlFileReader

Processes the map as read from SnakeYAML and may return a new, adjusted one.

NumberLeafValueHandler - Class in ch.jalu.configme.beanmapper.leafvaluehandler

Number handler for types without arbitrary precision.

NumberLeafValueHandler() - Constructor for class ch.jalu.configme.beanmapper.leafvaluehandler.NumberLeafValueHandler

numberOfLinesBeforeFunction(ToIntFunction<PropertyPathTraverser.PathElement>) - Method in class ch.jalu.configme.resource.YamlFileResourceOptions.Builder

O

ObjectLeafValueHandler - Class in ch.jalu.configme.beanmapper.leafvaluehandler

Object handler.

ObjectLeafValueHandler() - Constructor for class ch.jalu.configme.beanmapper.leafvaluehandler.ObjectLeafValueHandler

of(Class<B>, Mapper) - Static method in class ch.jalu.configme.properties.types.BeanPropertyType

of(Class<B>) - Static method in class ch.jalu.configme.properties.types.BeanPropertyType

of(Class<E>) - Static method in class ch.jalu.configme.properties.types.EnumPropertyType

onWriteComplete() - Method in class ch.jalu.configme.resource.YamlFileResource

Called at the end of YamlFileResource.exportProperties(ch.jalu.configme.configurationdata.ConfigurationData), regardless whether the execution was successful or not.

optionalBooleanProperty(String) - Static method in class ch.jalu.configme.properties.PropertyInitializer

optionalDoubleProperty(String) - Static method in class ch.jalu.configme.properties.PropertyInitializer

optionalEnumProperty(Class<E>, String) - Static method in class ch.jalu.configme.properties.PropertyInitializer

optionalFloatProperty(String) - Static method in class ch.jalu.configme.properties.PropertyInitializer

optionalIntegerProperty(String) - Static method in class ch.jalu.configme.properties.PropertyInitializer

optionalListProperty(String) - Static method in class ch.jalu.configme.properties.PropertyInitializer

optionalLongProperty(String) - Static method in class ch.jalu.configme.properties.PropertyInitializer

OptionalProperty<T> - Class in ch.jalu.configme.properties

Property which may be empty.

OptionalProperty(Property<T>) - Constructor for class ch.jalu.configme.properties.OptionalProperty

OptionalProperty(Property<T>, T) - Constructor for class ch.jalu.configme.properties.OptionalProperty

optionalRegexProperty(String) - Static method in class ch.jalu.configme.properties.PropertyInitializer

optionalSetProperty(String) - Static method in class ch.jalu.configme.properties.PropertyInitializer

optionalShortProperty(String) - Static method in class ch.jalu.configme.properties.PropertyInitializer

optionalStringProperty(String) - Static method in class ch.jalu.configme.properties.PropertyInitializer

P

path(String) - Method in class ch.jalu.configme.properties.PropertyBuilder

Sets the path of the property.

PathElement(int, String, String, boolean) - Constructor for class ch.jalu.configme.resource.PropertyPathTraverser.PathElement

performMigrations(PropertyReader, ConfigurationData) - Method in class ch.jalu.configme.migration.PlainMigrationService

Override this method for custom migrations.

performMigrations(PropertyReader, ConfigurationData) - Method in class ch.jalu.configme.migration.version.VersionMigrationService

Performs the migration by using the versioning system.

PlainMigrationService - Class in ch.jalu.configme.migration

Simple migration service that can be extended.

PlainMigrationService() - Constructor for class ch.jalu.configme.migration.PlainMigrationService

postProcessMap(Map<String, V>) - Method in class ch.jalu.configme.properties.MapProperty

PrimitivePropertyType<T> - Class in ch.jalu.configme.properties.types

Standard implementations of property types for basic types.

PrimitivePropertyType(Function<Object, T>) - Constructor for class ch.jalu.configme.properties.types.PrimitivePropertyType

Constructor.

PrimitivePropertyType(Function<Object, T>, Function<T, Object>) - Constructor for class ch.jalu.configme.properties.types.PrimitivePropertyType

Constructor.

Property<T> - Interface in ch.jalu.configme.properties

Property interface.

PropertyBuilder<K,T,B extends PropertyBuilder<K,T,B>> - Class in ch.jalu.configme.properties

Builder for complex types of properties.

PropertyBuilder(PropertyType<K>) - Constructor for class ch.jalu.configme.properties.PropertyBuilder

Constructor.

PropertyBuilder.ArrayPropertyBuilder<T> - Class in ch.jalu.configme.properties

Builder for ArrayProperty.

PropertyBuilder.CreateFunction<K,T> - Interface in ch.jalu.configme.properties

Function taking three arguments, which returns a property of the given type.

PropertyBuilder.InlineArrayPropertyBuilder<T> - Class in ch.jalu.configme.properties

Builder for InlineArrayProperty.

PropertyBuilder.ListPropertyBuilder<T> - Class in ch.jalu.configme.properties

Builder for ListProperty.

PropertyBuilder.MapPropertyBuilder<T> - Class in ch.jalu.configme.properties

Builder for MapProperty.

PropertyBuilder.SetPropertyBuilder<T> - Class in ch.jalu.configme.properties

Builder for SetProperty.

PropertyBuilder.TypeBasedPropertyBuilder<T> - Class in ch.jalu.configme.properties

Builder for TypeBasedProperty.

PropertyInitializer - Class in ch.jalu.configme.properties

Convenience class for instantiating Property objects.

PropertyInitializer() - Constructor for class ch.jalu.configme.properties.PropertyInitializer

propertyListBuilder - Variable in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

PropertyListBuilder - Class in ch.jalu.configme.configurationdata

Builds a list of known properties in an ordered and grouped manner.

PropertyListBuilder() - Constructor for class ch.jalu.configme.configurationdata.PropertyListBuilder

PropertyPathTraverser - Class in ch.jalu.configme.resource

Helper class for the export of properties: it keeps track of the previously traversed property and returns which path parts are new.

PropertyPathTraverser() - Constructor for class ch.jalu.configme.resource.PropertyPathTraverser

PropertyPathTraverser.PathElement - Class in ch.jalu.configme.resource

Represents the current element of a path which is currently being handled.

PropertyReader - Interface in ch.jalu.configme.resource

PropertyResource - Interface in ch.jalu.configme.resource

Represents a medium (typically a file on disk) from which property values should be built and allows to write back to it.

PropertyType<T> - Interface in ch.jalu.configme.properties.types

Property type: provides methods for converting between property resource and a defined type and allows to be used in generic structures such as an array property or map property.

PropertyValue<T> - Class in ch.jalu.configme.properties.convertresult

Return value of Property.determineValue(ch.jalu.configme.resource.PropertyReader).

PropertyValue(T, boolean) - Constructor for class ch.jalu.configme.properties.convertresult.PropertyValue

Constructor.

putNode(String, Node) - Method in interface ch.jalu.configme.resource.yaml.SnakeYamlNodeContainer

Saves the given node under the given name (= path element).

putNode(String, Node) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeContainerImpl

R

RegexProperty - Class in ch.jalu.configme.properties

Property whose value is a regex pattern.

RegexProperty(String, Pattern) - Constructor for class ch.jalu.configme.properties.RegexProperty

Constructor.

RegexProperty(String, String) - Constructor for class ch.jalu.configme.properties.RegexProperty

Constructor.

registerComments(CommentsConfiguration) - Method in interface ch.jalu.configme.SettingsHolder

Allows to register comments for sections and properties by overriding this method and interacting with the given configuration object.

registerError(String) - Method in interface ch.jalu.configme.beanmapper.MappingContext

Registers an error during the mapping process, which delegates to the supplied ConvertErrorRecorder, associated to the property this conversion is being performed for.

registerError(String) - Method in class ch.jalu.configme.beanmapper.MappingContextImpl

reload() - Method in interface ch.jalu.configme.SettingsManager

Reloads the configuration.

reload() - Method in class ch.jalu.configme.SettingsManagerImpl

repeat(T, int) - Static method in class ch.jalu.configme.utils.StreamUtils

Creates a stream with the requested size.

RETURN_NULL - Static variable in class ch.jalu.configme.beanmapper.MapperImpl

Marker object to signal that null is meant to be used as value.

returnLevelOfFirstNewPathElement(String) - Method in class ch.jalu.configme.resource.PropertyPathTraverser

Returns the hierarchy level of the highest path element that is being visited for the first time.

runApplicableMigrations(int, PropertyReader, ConfigurationData) - Method in class ch.jalu.configme.migration.version.VersionMigrationService

Runs applicable migrations successively: if a migration is found for the read config version, it is run and its target version is noted.

S

save() - Method in interface ch.jalu.configme.SettingsManager

Saves the properties to the configuration file.

save() - Method in class ch.jalu.configme.SettingsManagerImpl

setCollector() - Method in class ch.jalu.configme.properties.LowercaseStringSetProperty

setCollector() - Method in class ch.jalu.configme.properties.SetProperty

setComment(String, String...) - Method in class ch.jalu.configme.configurationdata.CommentsConfiguration

Sets the given lines for the provided path, overriding any previously existing comments for the path.

setCommentForPropertyField(Field, String) - Method in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

setEndOfPath(boolean) - Method in class ch.jalu.configme.resource.PropertyPathTraverser.PathElement

setFieldAccessibleIfNeeded(Field) - Method in class ch.jalu.configme.configurationdata.ConfigurationDataBuilder

Sets the Field object to be accessible if needed; this makes the code support constants in Kotlin without the @JvmField annotation.

setFirstOfGroup(boolean) - Method in class ch.jalu.configme.resource.PropertyPathTraverser.PathElement

setHasError(String) - Method in class ch.jalu.configme.properties.convertresult.ConvertErrorRecorder

Registers that some error occurred during the conversion of the value.

setProperty(PropertyType<T>) - Static method in class ch.jalu.configme.properties.PropertyInitializer

SetProperty<T> - Class in ch.jalu.configme.properties

Set property of configurable type.

SetProperty(String, PropertyType<T>, T...) - Constructor for class ch.jalu.configme.properties.SetProperty

Constructor.

SetProperty(String, PropertyType<T>, Set<T>) - Constructor for class ch.jalu.configme.properties.SetProperty

Constructor.

setProperty(Property<T>, T) - Method in interface ch.jalu.configme.SettingsManager

Sets a new value for the given property.

setProperty(Property<T>, T) - Method in class ch.jalu.configme.SettingsManagerImpl

Sets a new value for the given property.

SetPropertyBuilder(PropertyType<T>) - Constructor for class ch.jalu.configme.properties.PropertyBuilder.SetPropertyBuilder

SettingsHolder - Interface in ch.jalu.configme

Marker interface for classes that define Property objects.

SettingsHolderClassValidator - Class in ch.jalu.configme.utils

Validates various characteristics of the property implementations of SettingsHolder classes for consistency.

SettingsHolderClassValidator() - Constructor for class ch.jalu.configme.utils.SettingsHolderClassValidator

SettingsManager - Interface in ch.jalu.configme

Settings manager.

SettingsManagerBuilder - Class in ch.jalu.configme

Creates SettingsManager instances.

SettingsManagerImpl - Class in ch.jalu.configme

Default implementation of SettingsManager.

SettingsManagerImpl(PropertyResource, ConfigurationData, MigrationService) - Constructor for class ch.jalu.configme.SettingsManagerImpl

Constructor.

setValue(Object, Object) - Method in interface ch.jalu.configme.beanmapper.propertydescription.BeanPropertyDescription

Sets the given value on the provided bean for this property.

setValue(Object, Object) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanPropertyDescriptionImpl

Sets the given property to the given value on the provided bean.

setValue(Property<T>, T) - Method in interface ch.jalu.configme.configurationdata.ConfigurationData

Sets the given value for the given property.

setValue(Property<T>, T) - Method in class ch.jalu.configme.configurationdata.ConfigurationDataImpl

setValueForProperty(Property<T>, PropertyReader) - Method in class ch.jalu.configme.configurationdata.ConfigurationDataImpl

SHORT - Static variable in class ch.jalu.configme.properties.inlinearray.StandardInlineArrayConverters

SHORT - Static variable in class ch.jalu.configme.properties.types.PrimitivePropertyType

ShortProperty - Class in ch.jalu.configme.properties

Short property.

ShortProperty(String, Short) - Constructor for class ch.jalu.configme.properties.ShortProperty

SnakeYamlNodeBuilder - Interface in ch.jalu.configme.resource.yaml

Creates SnakeYAML nodes for values and comments.

SnakeYamlNodeBuilderImpl - Class in ch.jalu.configme.resource.yaml

Default implementation of SnakeYamlNodeBuilder: creates SnakeYAML nodes for values and comments.

SnakeYamlNodeBuilderImpl() - Constructor for class ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilderImpl

SnakeYamlNodeContainer - Interface in ch.jalu.configme.resource.yaml

Container that keeps SnakeYAML node objects in hierarchical order.

SnakeYamlNodeContainerImpl - Class in ch.jalu.configme.resource.yaml

Implementation of SnakeYamlNodeContainer.

SnakeYamlNodeContainerImpl(List<String>) - Constructor for class ch.jalu.configme.resource.yaml.SnakeYamlNodeContainerImpl

sortPropertiesList(Class<?>, List<PropertyDescriptor>) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

Returns a sorted list of the given properties which will be used for further processing and whose order will be maintained.

splitDotPaths() - Method in class ch.jalu.configme.resource.MapNormalizer

splitDotPaths(boolean) - Method in class ch.jalu.configme.resource.YamlFileResourceOptions.Builder

splitDotPaths() - Method in class ch.jalu.configme.resource.YamlFileResourceOptions

StandardInlineArrayConverters<T> - Class in ch.jalu.configme.properties.inlinearray

Standard implementations of InlineArrayConverter.

StandardInlineArrayConverters(String, IntFunction<T[]>, Function<String, T>) - Constructor for class ch.jalu.configme.properties.inlinearray.StandardInlineArrayConverters

StandardInlineArrayConverters(String, IntFunction<T[]>, Function<String, T>, boolean) - Constructor for class ch.jalu.configme.properties.inlinearray.StandardInlineArrayConverters

Constructor.

StandardLeafValueHandlers - Class in ch.jalu.configme.beanmapper.leafvaluehandler

Provides the leaf value handler which is used by default.

streamThroughCommentsIfApplicable(Object, Set<UUID>) - Static method in class ch.jalu.configme.properties.convertresult.ValueWithComments

Returns a stream with the comments on the given object, if it is a ValueWithComments and its comments aren't specified to be unique, or if the comments are encountered for the first time.

StreamUtils - Class in ch.jalu.configme.utils

Stream utils.

STRING - Static variable in class ch.jalu.configme.properties.inlinearray.StandardInlineArrayConverters

STRING - Static variable in class ch.jalu.configme.properties.types.PrimitivePropertyType

StringLeafValueHandler - Class in ch.jalu.configme.beanmapper.leafvaluehandler

String handler.

StringLeafValueHandler() - Constructor for class ch.jalu.configme.beanmapper.leafvaluehandler.StringLeafValueHandler

StringListProperty - Class in ch.jalu.configme.properties

String list property.

StringListProperty(String, String...) - Constructor for class ch.jalu.configme.properties.StringListProperty

StringListProperty(String, List<String>) - Constructor for class ch.jalu.configme.properties.StringListProperty

StringProperty - Class in ch.jalu.configme.properties

String property.

StringProperty(String, String) - Constructor for class ch.jalu.configme.properties.StringProperty

StringSetProperty - Class in ch.jalu.configme.properties

String set property.

StringSetProperty(String, String...) - Constructor for class ch.jalu.configme.properties.StringSetProperty

Constructor.

StringSetProperty(String, Set<String>) - Constructor for class ch.jalu.configme.properties.StringSetProperty

Constructor.

T

targetVersion() - Method in interface ch.jalu.configme.migration.version.VersionMigration

throwExceptionForMalformedPath(String) - Method in class ch.jalu.configme.configurationdata.PropertyListBuilder

toExportValue(Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.BigNumberLeafValueHandler

toExportValue(Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.BooleanLeafValueHandler

toExportValue(Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.CombiningLeafValueHandler

toExportValue(Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.EnumLeafValueHandler

toExportValue(Object) - Method in interface ch.jalu.configme.beanmapper.leafvaluehandler.LeafValueHandler

Converts the given value to a type more suitable for exporting.

toExportValue(Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.NumberLeafValueHandler

toExportValue(Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.ObjectLeafValueHandler

toExportValue(Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.StringLeafValueHandler

toExportValue(Object) - Method in interface ch.jalu.configme.beanmapper.Mapper

Converts a complex type such as a JavaBean object to simple types suitable for exporting.

toExportValue(Object) - Method in class ch.jalu.configme.beanmapper.MapperImpl

toExportValue(Object, Set<UUID>) - Method in class ch.jalu.configme.beanmapper.MapperImpl

Transforms the given value to an object suitable for the export to a configuration file.

toExportValue(T[]) - Method in class ch.jalu.configme.properties.ArrayProperty

toExportValue(T[]) - Method in interface ch.jalu.configme.properties.inlinearray.InlineArrayConverter

Converts the provided array to its String representation (opposite of InlineArrayConverter.fromString(String)).

toExportValue(T[]) - Method in class ch.jalu.configme.properties.inlinearray.StandardInlineArrayConverters

toExportValue(T[]) - Method in class ch.jalu.configme.properties.InlineArrayProperty

toExportValue(List<T>) - Method in class ch.jalu.configme.properties.ListProperty

toExportValue(Map<String, V>) - Method in class ch.jalu.configme.properties.MapProperty

toExportValue(Optional<T>) - Method in class ch.jalu.configme.properties.OptionalProperty

toExportValue(T) - Method in interface ch.jalu.configme.properties.Property

Converts the given value to a representation that is suitable for exporting by a property resource.

toExportValue(Pattern) - Method in class ch.jalu.configme.properties.RegexProperty

toExportValue(Set<T>) - Method in class ch.jalu.configme.properties.SetProperty

toExportValue(List<String>) - Method in class ch.jalu.configme.properties.StringListProperty

toExportValue(Set<String>) - Method in class ch.jalu.configme.properties.StringSetProperty

toExportValue(T) - Method in class ch.jalu.configme.properties.TypeBasedProperty

toExportValue(B) - Method in class ch.jalu.configme.properties.types.BeanPropertyType

toExportValue(E) - Method in class ch.jalu.configme.properties.types.EnumPropertyType

toExportValue(T) - Method in class ch.jalu.configme.properties.types.PrimitivePropertyType

toExportValue(T) - Method in interface ch.jalu.configme.properties.types.PropertyType

Converts the given value to its export value.

toLowercaseLinkedHashSet(Stream<String>) - Static method in class ch.jalu.configme.properties.LowercaseStringSetProperty

toString() - Method in class ch.jalu.configme.beanmapper.MappingContextImpl

toString() - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanPropertyDescriptionImpl

toString() - Method in class ch.jalu.configme.properties.BaseProperty

toString() - Method in class ch.jalu.configme.properties.convertresult.PropertyValue

toString() - Method in class ch.jalu.configme.utils.TypeInformation

transferComments(Node, Node) - Method in interface ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilder

Transfers the comments from the value node to the key node.

transferComments(Node, Node) - Method in class ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilderImpl

tryGetField(Class<?>, String) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

Returns the field with the given name on the provided class, or null if it doesn't exist.

typeBasedProperty(PropertyType<T>) - Static method in class ch.jalu.configme.properties.PropertyInitializer

TypeBasedProperty<T> - Class in ch.jalu.configme.properties

Property implementation which relies on a PropertyType.

TypeBasedProperty(String, T, PropertyType<T>) - Constructor for class ch.jalu.configme.properties.TypeBasedProperty

Constructor.

TypeBasedPropertyBuilder(PropertyType<T>) - Constructor for class ch.jalu.configme.properties.PropertyBuilder.TypeBasedPropertyBuilder

TypeInformation - Class in ch.jalu.configme.utils

Encapsulates type information.

TypeInformation(Type) - Constructor for class ch.jalu.configme.utils.TypeInformation

Constructor.

U

unwrapReturnNull(Object) - Static method in class ch.jalu.configme.beanmapper.MapperImpl

unwrapValue(Object) - Static method in class ch.jalu.configme.properties.convertresult.ValueWithComments

Unwraps the value and returns the actual value contained in this wrapper if the object is an instance of this class.

useDefaultMigrationService() - Method in class ch.jalu.configme.SettingsManagerBuilder

Registers the default migration service to the builder, which triggers a rewrite of the configuration file if a property is missing from it.

Utils - Class in ch.jalu.configme.utils

Utilities class.

V

validate(Class<? extends SettingsHolder>...) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

Runs all validations of this class with the given settings holder classes.

validate(Iterable<Class<? extends SettingsHolder>>) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

Runs all validations of this class with the given settings holder classes.

validateAllPropertiesAreConstants(Iterable<Class<? extends SettingsHolder>>) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

Throws an exception if any Property field of the given classes is not public, static, or final.

validateAndGroupMigrationsByFromVersion(Iterable<VersionMigration>) - Method in class ch.jalu.configme.migration.version.VersionMigrationService

Validates the given migrations and returns them as a map of migration by its start version.

validateClassesHaveHiddenNoArgConstructor(Iterable<Class<? extends SettingsHolder>>) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

Throws an exception if any of the provided setting holder classes does not have a single private no-args constructor.

validateCommentLengthsAreWithinBounds(ConfigurationData, Integer, Integer) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

Throws an exception if any comment line in the configuration data has a length is not between the given minLength and maxLength, inclusive: minLength <= length <= maxLength.

validateConfigurationDataValidForMigrationService(ConfigurationData, PropertyResource, MigrationService) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

Validates that the migration service does not declare that a migration is required for the given configuration data, which gets saved to the provided resource beforehand.

validateHasAllEnumEntriesInComment(ConfigurationData, Predicate<Property<?>>) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

Throws an exception if the comments of an enum property do not list all entries of the enum type.

validateHasCommentOnEveryProperty(ConfigurationData, Predicate<Property<?>>) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

Throws an exception if there isn't a non-empty comment for every property in the configuration data.

validateProperties(Class<?>, Collection<BeanPropertyDescription>) - Method in class ch.jalu.configme.beanmapper.propertydescription.BeanDescriptionFactoryImpl

Validates the class's properties.

validateSettingsHolderClassesFinal(Iterable<Class<? extends SettingsHolder>>) - Method in class ch.jalu.configme.utils.SettingsHolderClassValidator

Throws an exception if any of the provided settings holder classes is not final.

validateVersions(VersionMigration) - Method in class ch.jalu.configme.migration.version.VersionMigrationService

Validates the from-version and to-version of the migration.

ValueWithComments - Class in ch.jalu.configme.properties.convertresult

Wraps a value and allows to associate it with comments.

ValueWithComments(Object, List<String>, UUID) - Constructor for class ch.jalu.configme.properties.convertresult.ValueWithComments

Constructor.

ValueWithComments(Object, List<String>) - Constructor for class ch.jalu.configme.properties.convertresult.ValueWithComments

Constructor.

VersionMigration - Interface in ch.jalu.configme.migration.version

A migration used by VersionMigrationService to migrate from one configuration version to a newer one.

VersionMigrationService - Class in ch.jalu.configme.migration.version

Version-based MigrationService implementation that uses a Property<Integer> to track configuration versions, based on which it triggers migrations.

VersionMigrationService(Property<Integer>, Iterable<VersionMigration>) - Constructor for class ch.jalu.configme.migration.version.VersionMigrationService

Constructor.

VersionMigrationService(Property<Integer>, VersionMigration...) - Constructor for class ch.jalu.configme.migration.version.VersionMigrationService

Constructor.

W

withResource(PropertyResource) - Static method in class ch.jalu.configme.SettingsManagerBuilder

Creates a new builder with the given property resource.

withValidValue(T) - Static method in class ch.jalu.configme.properties.convertresult.PropertyValue

Creates a new instance for the given value which indicates that it is fully valid in the resource.

withValueRequiringRewrite(T) - Static method in class ch.jalu.configme.properties.convertresult.PropertyValue

Creates a new instance for the given value which indicates that its representation in the resource is NOT valid.

withYamlFile(Path) - Static method in class ch.jalu.configme.SettingsManagerBuilder

Creates a builder, using the given YAML file to use as property resource.

withYamlFile(File) - Static method in class ch.jalu.configme.SettingsManagerBuilder

Creates a builder, using the given YAML file to use as property resource.

withYamlFile(Path, YamlFileResourceOptions) - Static method in class ch.jalu.configme.SettingsManagerBuilder

Creates a builder, using the given YAML file to use as property resource with the given options.

withYamlFile(File, YamlFileResourceOptions) - Static method in class ch.jalu.configme.SettingsManagerBuilder

Creates a builder, using the given YAML file to use as property resource with the given options.

Y

YamlFileReader - Class in ch.jalu.configme.resource

YAML file reader.

YamlFileReader(Path) - Constructor for class ch.jalu.configme.resource.YamlFileReader

Constructor.

YamlFileReader(Path, Charset) - Constructor for class ch.jalu.configme.resource.YamlFileReader

Constructor.

YamlFileReader(Path, Charset, boolean) - Constructor for class ch.jalu.configme.resource.YamlFileReader

Constructor.

YamlFileReader(File) - Constructor for class ch.jalu.configme.resource.YamlFileReader

Deprecated.

scheduled for removal in favor of Path

YamlFileResource - Class in ch.jalu.configme.resource

YamlFileResource(Path) - Constructor for class ch.jalu.configme.resource.YamlFileResource

YamlFileResource(Path, YamlFileResourceOptions) - Constructor for class ch.jalu.configme.resource.YamlFileResource

YamlFileResource(File) - Constructor for class ch.jalu.configme.resource.YamlFileResource

Deprecated.

scheduled for removal

YamlFileResourceOptions - Class in ch.jalu.configme.resource

YamlFileResourceOptions(Charset, ToIntFunction<PropertyPathTraverser.PathElement>, int, boolean) - Constructor for class ch.jalu.configme.resource.YamlFileResourceOptions

Constructor.

YamlFileResourceOptions.Builder - Class in ch.jalu.configme.resource

A B C D E F G H I L M N O P R S T U V W Y