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

A

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

B

BeanDescriptionFactory - Class in ch.jalu.configme.beanmapper

Creates all BeanPropertyDescription objects for a given class.

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

beanProperty - Variable in class ch.jalu.configme.beanmapper.leafproperties.LeafPropertiesGenerator.EntryBuilder

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

Property constructed by bean mapping.

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

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

BeanPropertyDescription - Class in ch.jalu.configme.beanmapper

Information about a bean property.

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

BooleanProperty - Class in ch.jalu.configme.properties

Boolean property.

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

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

Builds a TypeInformation object for the underlying generic type at the given index.

C

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

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

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

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

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(PropertyResource, List<Property<?>>) - Method in interface ch.jalu.configme.migration.MigrationService

Checks the settings and perform any necessary migrations.

checkAndMigrate(PropertyResource, List<Property<?>>) - Method in class ch.jalu.configme.migration.PlainMigrationService

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

Collects all properties and comment data from the provided classes.

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

Collects all properties and comment data from the provided classes.

CollectionUtils - Class in ch.jalu.configme.utils

Collection utils.

collectPropertiesFromBean(Object, String) - Method in class ch.jalu.configme.beanmapper.leafproperties.LeafPropertiesGenerator.EntryBuilder

Processes a bean class and handles all of its writable properties.

collectPropertyEntries(Object, String) - Method in class ch.jalu.configme.beanmapper.leafproperties.LeafPropertiesGenerator.EntryBuilder

Creates property entries for the provided value, recursively for beans.

collectWritableFields(Class<?>) - Method in class ch.jalu.configme.beanmapper.BeanDescriptionFactory

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

Comment - Annotation Type in ch.jalu.configme

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

comments - Variable in class ch.jalu.configme.resource.PropertyPathTraverser.PathElement

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

ConfigMeMapper - Class in ch.jalu.configme.beanmapper

Mapper configured with defaults as singleton.

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.

ConfigurationData - Class in ch.jalu.configme.configurationdata

Contains information about the available properties and their associated comments.

ConfigurationData(List<? extends Property<?>>) - Constructor for class ch.jalu.configme.configurationdata.ConfigurationData

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

configurationData - Variable in class ch.jalu.configme.SettingsManager

ConfigurationDataBuilder - Class in ch.jalu.configme.configurationdata

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

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

Returns whether a value is present for the given path.

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

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

Converts a PropertyDescriptor to a BeanPropertyDescription object.

convertPropertiesToExportableTypes(List<Property<?>>) - Method in class ch.jalu.configme.resource.YamlFileResource

Converts the property entries to exportable "leaf" properties.

convertToBean(String, PropertyResource, Class<T>) - Method in class ch.jalu.configme.beanmapper.Mapper

Converts the value in the property resource at the given path to the provided beans class.

convertToBean(TypeInformation<T>, Object, MappingContext) - Method in class ch.jalu.configme.beanmapper.Mapper

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

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

createChild(TypeInformation<?>) - Method in class ch.jalu.configme.beanmapper.MappingContext

createConstantProperty(Object, String) - Method in class ch.jalu.configme.beanmapper.leafproperties.LeafPropertiesGenerator.EntryBuilder

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

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

createWithProperties(PropertyResource, MigrationService, Collection<? extends Property<?>>) - Static method in class ch.jalu.configme.SettingsManager

Convenience method for creating a settings manager for the given collection of properties.

createWithYamlFile(File, Class<? extends SettingsHolder>...) - Static method in class ch.jalu.configme.SettingsManager

Convenience method for creating a settings manager for the provided YAML file with defaults.

E

EntryBuilder(BeanProperty) - Constructor for class ch.jalu.configme.beanmapper.leafproperties.LeafPropertiesGenerator.EntryBuilder

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

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 properties (e.g.

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

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.

G

generate(BeanProperty<B>, B) - Method in class ch.jalu.configme.beanmapper.leafproperties.LeafPropertiesGenerator

Generates a list of regular property objects for the given bean's data.

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

Returns the underlying property used to retrieve the value of the optional.

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

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

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

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

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

getDefaultTransformers() - Static method in class ch.jalu.configme.beanmapper.transformer.Transformers

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

Returns the default value of the property.

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

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

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

getFromResource(PropertyResource) - Method in class ch.jalu.configme.properties.BeanProperty

getFromResource(PropertyResource) - Method in class ch.jalu.configme.properties.BooleanProperty

getFromResource(PropertyResource) - Method in class ch.jalu.configme.properties.EnumProperty

getFromResource(PropertyResource) - Method in class ch.jalu.configme.properties.IntegerProperty

getFromResource(PropertyResource) - Method in class ch.jalu.configme.properties.LowercaseStringListProperty

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

getFromResource(PropertyResource) - Method in class ch.jalu.configme.properties.Property

getFromResource(PropertyResource) - Method in class ch.jalu.configme.properties.StringListProperty

getFromResource(PropertyResource) - Method in class ch.jalu.configme.properties.StringProperty

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

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

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

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

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

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

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

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

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

Returns the name of the property for the purpose of reading from and writing to a property resource.

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

Returns the value for the given path, or null if not present.

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

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

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

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

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

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

Returns the property path.

getPathElements(Property<?>) - 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 class ch.jalu.configme.configurationdata.ConfigurationData

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

Gets the given property from the configuration.

getPropertyName(PropertyDescriptor) - Method in class ch.jalu.configme.beanmapper.BeanDescriptionFactory

getPropertyValue(TypeInformation, Object, MappingContext) - Method in class ch.jalu.configme.beanmapper.Mapper

Returns a value of type clazz based on the provided value if possible.

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

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

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

Returns a YAML instance set to export values with the default style.

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

Returns a YAML instance set to export values with single quotes.

getSingleton() - Static method in class ch.jalu.configme.beanmapper.ConfigMeMapper

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

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

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

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

Returns the value for the given path in a typed manner.

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

getTypeInfo(PropertyDescriptor) - Method in class ch.jalu.configme.beanmapper.BeanDescriptionFactory

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

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

Returns the value of the property for the given bean.

getValue(PropertyResource) - Method in class ch.jalu.configme.properties.Property

Gets the property value from the given resource and falls back to the default value if not present.

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

Returns the properties of the given bean class that need to be considered when constructing objects.

getWritableProperties(Class<?>) - Method in class ch.jalu.configme.properties.BeanProperty

Returns the properties of the bean class to consider while creating the object.

H

handleCollection(Collection<?>, String) - Method in class ch.jalu.configme.beanmapper.leafproperties.LeafPropertiesGenerator.EntryBuilder

Handles a value that is of Collection type.

handleError(Class<?>, MappingContext) - Method in interface ch.jalu.configme.beanmapper.MappingErrorHandler

I

indentationLevel - Variable in class ch.jalu.configme.resource.PropertyPathTraverser.PathElement

IntegerProperty - Class in ch.jalu.configme.properties

Integer property.

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

isOfType(Class<?>) - Method in class ch.jalu.configme.utils.TypeInformation

Returns whether this type is equal to or a child of the given type.

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

isPresent(PropertyResource) - Method in class ch.jalu.configme.properties.Property

Returns whether or not the given resource contains the property.

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

L

LeafPropertiesGenerator - Class in ch.jalu.configme.beanmapper.leafproperties

Generates Property objects for all "leaf" values of a bean for the export of beans by the PropertyResource.

LeafPropertiesGenerator() - Constructor for class ch.jalu.configme.beanmapper.leafproperties.LeafPropertiesGenerator

LeafPropertiesGenerator.EntryBuilder - Class in ch.jalu.configme.beanmapper.leafproperties

LowercaseStringListProperty - Class in ch.jalu.configme.properties

Lowercase String list property.

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

M

Mapper - Class in ch.jalu.configme.beanmapper

Maps a section of a property resource to the provided JavaBean class.

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

Creates a new JavaBean mapper with the default configuration.

Mapper(MappingErrorHandler, BeanDescriptionFactory, Transformer...) - Constructor for class ch.jalu.configme.beanmapper.Mapper

Creates a new JavaBean mapper with the given elements.

MappingContext - Class in ch.jalu.configme.beanmapper

Context in which a mapping takes place.

MappingErrorHandler - Interface in ch.jalu.configme.beanmapper

Error handler when a mapping is unsuccessful.

MappingErrorHandler.Impl - Enum in ch.jalu.configme.beanmapper

Implementations.

MigrationService - Interface in ch.jalu.configme.migration

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

migrationService - Variable in class ch.jalu.configme.SettingsManager

N

name - Variable in class ch.jalu.configme.resource.PropertyPathTraverser.PathElement

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.

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

Creates a new String list 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, 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.

O

of(Class<T>) - Static method in class ch.jalu.configme.utils.TypeInformation

of(Class<T>, Type) - Static method in class ch.jalu.configme.utils.TypeInformation

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<? extends T>) - Constructor for class ch.jalu.configme.properties.OptionalProperty

Constructor.

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

P

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

performMigrations(PropertyResource, List<Property<?>>) - 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

processCollection(TypeInformation<?>, Object, MappingContext) - Method in class ch.jalu.configme.beanmapper.Mapper

processMap(TypeInformation<?>, Object, MappingContext) - Method in class ch.jalu.configme.beanmapper.Mapper

processTransformers(TypeInformation, Object) - Method in class ch.jalu.configme.beanmapper.Mapper

properties - Variable in class ch.jalu.configme.beanmapper.leafproperties.LeafPropertiesGenerator.EntryBuilder

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

A property, i.e.

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

PropertyInitializer - Class in ch.jalu.configme.properties

Convenience class for instantiating Property objects.

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

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

Property reader.

PropertyResource - Interface in ch.jalu.configme.resource

Property resource; provides and exports properties.

R

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

Reloads the properties from the external source.

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

Reloads the configuration, e.g.

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

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

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

Reloads the configuration.

resource - Variable in class ch.jalu.configme.SettingsManager

root() - Static method in class ch.jalu.configme.beanmapper.MappingContext

S

safeTransform(Class<? extends R>, S) - Method in class ch.jalu.configme.beanmapper.transformer.TypedTransformer

Transforms the given value to the provided type.

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

Saves the config file.

SectionComments - Annotation Type in ch.jalu.configme

Annotation for methods in SettingsHolder classes that return section comments to include when saving to a file.

set(String, Object) - Method in interface ch.jalu.configme.resource.PropertyReader

Sets the value at the given path in memory.

set(String, Object) - Method in class ch.jalu.configme.resource.YamlFileReader

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

Sets a new value for the given property.

SettingsHolder - Interface in ch.jalu.configme

Marker interface for classes that have Property objects.

SettingsManager - Class in ch.jalu.configme

Settings manager.

SettingsManager(PropertyResource, MigrationService, Class<? extends SettingsHolder>...) - Constructor for class ch.jalu.configme.SettingsManager

Constructor.

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

Constructor.

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

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

setValue(String, Object) - Method in interface ch.jalu.configme.resource.PropertyResource

Sets the value for the given path.

setValue(String, Object) - Method in class ch.jalu.configme.resource.YamlFileResource

StringListProperty - Class in ch.jalu.configme.properties

String list property.

StringListProperty(String, 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

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

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

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

transform(TypeInformation<?>, Object) - Method in interface ch.jalu.configme.beanmapper.transformer.Transformer

Transforms the provided value to the requested type, if possible.

transform(TypeInformation<?>, Object) - Method in class ch.jalu.configme.beanmapper.transformer.TypedTransformer

Transformer - Interface in ch.jalu.configme.beanmapper.transformer

Transformers convert a value read from a property resource to the requested type to set into a JavaBean.

Transformers - Class in ch.jalu.configme.beanmapper.transformer

Default transformer implementations.

transformValue(Property<?>, Object) - Method in class ch.jalu.configme.resource.YamlFileResource

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

TypedTransformer<S,R> - Class in ch.jalu.configme.beanmapper.transformer

Typed implementation of Transformer for convenient extension.

TypedTransformer(Class<S>, Class<R>) - Constructor for class ch.jalu.configme.beanmapper.transformer.TypedTransformer

Constructs a transformer for the specified source and result type.

TypeInformation<T> - Class in ch.jalu.configme.utils

Encapsulates type information.

U

Utils - Class in ch.jalu.configme.utils

Utilities class.

V

validateAndLoadOptions() - Method in class ch.jalu.configme.SettingsManager

Checks with the migration service if the configuration is up to date.

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

Validates the class' properties.

valueOf(String) - Static method in enum ch.jalu.configme.beanmapper.MappingErrorHandler.Impl

Returns the enum constant of this type with the specified name.

values() - Static method in enum ch.jalu.configme.beanmapper.MappingErrorHandler.Impl

Returns an array containing the constants of this enum type, in the order they are declared.

Y

YamlFileReader - Class in ch.jalu.configme.resource

YAML file reader.

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

Constructor.

YamlFileResource - Class in ch.jalu.configme.resource

Property resource based on a YAML file.

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

Constructor.

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

Constructor.

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