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.

asReferenceClass(Class<?>) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.StandardLeafValueHandlers.NumberHandler

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.

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

Constructor.

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

BooleanProperty - Class in ch.jalu.configme.properties

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

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.properties - package ch.jalu.configme.properties

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

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

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

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

Collects all properties available on the given class.

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.

CollectionUtils - Class in ch.jalu.configme.utils

Collection utils.

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 YAML 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(MappingContext, String) - Constructor for exception ch.jalu.configme.beanmapper.ConfigMeMapperException

Creates an exception which incorporates the mapping context's description into the provided message.

ConfigMeMapperException(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(TypeInformation, Object) - Method in class ch.jalu.configme.beanmapper.leafvaluehandler.CombiningLeafValueHandler

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

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

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

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

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

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

Converts a PropertyDescriptor to a BeanPropertyDescription object.

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

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

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

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

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

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

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.

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

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

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

Creates an object matching the given type information.

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(TypeInformation) - Method in class ch.jalu.configme.beanmapper.MapperImpl

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

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

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

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

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

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

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

Attempts to create the given file if it doesn't exist.

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

Handles the creation of a Map property.

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

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

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

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) - Static method in class ch.jalu.configme.beanmapper.MappingContextImpl

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

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

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

Creates an instance of the given settings holder class.

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

D

DefaultMapper - Class in ch.jalu.configme.beanmapper

Provides the Mapper instance which is used by default.

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

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.

DoubleProperty - Class in ch.jalu.configme.properties

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

E

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

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

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

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

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

Annotation placed on a 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

exportValue(Writer, PropertyPathTraverser, String, Object) - Method in class ch.jalu.configme.resource.YamlFileResource

Exports the given value at the provided path.

F

filterCommonStart(List<T>, List<T>) - Static method in class ch.jalu.configme.utils.CollectionUtils

Returns all entries that are the same at the beginning of both given lists.

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

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

G

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

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

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

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 interface ch.jalu.configme.properties.Property

Returns the default value of this property.

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

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

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

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

Constructs the value of the property from the property reader.

getFromReader(PropertyReader) - Method in class ch.jalu.configme.properties.BeanProperty

getFromReader(PropertyReader) - Method in class ch.jalu.configme.properties.BooleanProperty

getFromReader(PropertyReader) - Method in class ch.jalu.configme.properties.DoubleProperty

getFromReader(PropertyReader) - Method in class ch.jalu.configme.properties.EnumProperty

getFromReader(PropertyReader) - Method in class ch.jalu.configme.properties.IntegerProperty

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

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

getFromReader(PropertyReader) - Method in class ch.jalu.configme.properties.StringListProperty

getFromReader(PropertyReader) - Method in class ch.jalu.configme.properties.StringProperty

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

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

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

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

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

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

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

Returns all path elements for the given property that have not been traversed yet.

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

getRange(List<T>, int) - Static method in class ch.jalu.configme.utils.CollectionUtils

Gets all elements from a list starting from the given index.

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

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

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

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

I

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

Returns a String of whitespace for indentation in YAML at the given level.

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

IntegerProperty - Class in ch.jalu.configme.properties

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

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

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

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

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

Returns true if a valid value for this property is present in the property reader, i.e.

isPresent(PropertyReader) - Method in class ch.jalu.configme.properties.StringListProperty

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

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.

loadFile() - 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).

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

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) - Constructor for class ch.jalu.configme.beanmapper.MappingContextImpl

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.

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

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.

newLowercaseStringSetProperty(String, 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, int) - Static method in class ch.jalu.configme.properties.PropertyInitializer

Creates a new integer 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.

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.

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

O

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

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

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

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

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

P

PathElement(int, String, List<String>) - 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.

PlainMigrationService - Class in ch.jalu.configme.migration

Simple migration service that can be extended.

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

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

Property interface.

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 and defines the level of indentation.

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

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

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.

R

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.

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

Reloads the configuration.

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

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

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

S

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

Saves the properties to the configuration file.

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

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

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.

SettingsHolder - Interface in ch.jalu.configme

Marker interface for classes that define Property objects.

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

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

Contains default leaf value handlers implementations and provides the leaf value handler which is used by default.

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

Boolean handler.

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

Enum handler.

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

Number handler.

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

Object handler.

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

String handler.

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

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

T

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

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

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

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

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

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

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(T) - Method in class ch.jalu.configme.properties.BeanProperty

toExportValue(Boolean) - Method in class ch.jalu.configme.properties.BooleanProperty

toExportValue(Double) - Method in class ch.jalu.configme.properties.DoubleProperty

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

toExportValue(Integer) - Method in class ch.jalu.configme.properties.IntegerProperty

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

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(List<String>) - Method in class ch.jalu.configme.properties.StringListProperty

toExportValue(String) - Method in class ch.jalu.configme.properties.StringProperty

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

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

Returns the YAML representation for the given value (belonging to the given value).

toYamlIndented(Object, int) - Method in class ch.jalu.configme.resource.YamlFileResource

Returns the value in its YAML representation with an indentation of the given level.

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

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

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

Validates the class' properties.

W

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

Creates a new builder with the given 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.

writeComments(Writer, int, List<String>) - Method in class ch.jalu.configme.resource.YamlFileResource

Writes the given comment lines as YAML comments at the given indentation level.

Y

YamlFileReader - Class in ch.jalu.configme.resource

YAML file reader.

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

Constructor.

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

YamlFileResource - Class in ch.jalu.configme.resource

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

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