| Package | Description |
|---|---|
| ch.jalu.configme | |
| ch.jalu.configme.configurationdata | |
| ch.jalu.configme.migration | |
| ch.jalu.configme.resource | |
| ch.jalu.configme.utils |
| Modifier and Type | Method and Description |
|---|---|
protected ConfigurationData |
SettingsManagerImpl.getConfigurationData() |
| Modifier and Type | Method and Description |
|---|---|
SettingsManagerBuilder |
SettingsManagerBuilder.configurationData(ConfigurationData configurationData)
Sets the provided configuration data to the builder.
|
| Constructor and Description |
|---|
SettingsManagerImpl(PropertyResource resource,
ConfigurationData configurationData,
MigrationService migrationService)
Constructor.
|
| Modifier and Type | Class and Description |
|---|---|
class |
ConfigurationDataImpl
Contains information about the available properties and their associated comments.
|
| Modifier and Type | Method and Description |
|---|---|
protected ConfigurationData |
ConfigurationDataBuilder.collectData(Iterable<Class<? extends SettingsHolder>> classes)
Collects property data and comment info from the given class and creates a configuration data
instance with it.
|
static ConfigurationData |
ConfigurationDataBuilder.createConfiguration(Class<? extends SettingsHolder>... classes)
Collects all properties and comment data from the provided classes.
|
static ConfigurationData |
ConfigurationDataBuilder.createConfiguration(Iterable<Class<? extends SettingsHolder>> classes)
Collects all properties and comment data from the provided classes.
|
static ConfigurationData |
ConfigurationDataBuilder.createConfiguration(List<? extends Property<?>> properties) |
static ConfigurationData |
ConfigurationDataBuilder.createConfiguration(List<? extends Property<?>> properties,
CommentsConfiguration commentsConfiguration) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
PlainMigrationService.checkAndMigrate(PropertyReader reader,
ConfigurationData configurationData) |
boolean |
MigrationService.checkAndMigrate(PropertyReader reader,
ConfigurationData configurationData)
Performs the migration, returning whether a migration has been performed or not.
|
protected static <T> boolean |
PlainMigrationService.moveProperty(Property<T> oldProperty,
Property<T> newProperty,
PropertyReader reader,
ConfigurationData configurationData)
Utility method: moves the value of an old property to a new property.
|
protected boolean |
PlainMigrationService.performMigrations(PropertyReader reader,
ConfigurationData configurationData)
Override this method for custom migrations.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PropertyResource.exportProperties(ConfigurationData configurationData)
Exports the provided configuration data to the medium (typically a file).
|
void |
YamlFileResource.exportProperties(ConfigurationData configurationData) |
| Constructor and Description |
|---|
PropertyPathTraverser(ConfigurationData configurationData) |
| Modifier and Type | Method and Description |
|---|---|
protected ConfigurationData |
SettingsHolderClassValidator.createConfigurationData(Iterable<Class<? extends SettingsHolder>> classes) |
| Modifier and Type | Method and Description |
|---|---|
void |
SettingsHolderClassValidator.validateCommentLengthsAreWithinBounds(ConfigurationData configurationData,
Integer minLength,
Integer maxLength)
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. |
void |
SettingsHolderClassValidator.validateConfigurationDataValidForMigrationService(ConfigurationData configurationData,
PropertyResource resource,
MigrationService migrationService)
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.
|
void |
SettingsHolderClassValidator.validateHasAllEnumEntriesInComment(ConfigurationData configurationData,
Predicate<Property<?>> propertyFilter)
Throws an exception if the comments of an enum property do not list all entries of the enum type.
|
void |
SettingsHolderClassValidator.validateHasCommentOnEveryProperty(ConfigurationData configurationData,
Predicate<Property<?>> propertyFilter)
Throws an exception if there isn't a non-empty comment for every property in the configuration data.
|
Copyright © 2016–2021 The AuthMe Team. All rights reserved.