ch.jalu.configme.utils

Class SettingsHolderClassValidator

java.lang.Object

ch.jalu.configme.utils.SettingsHolderClassValidator

public class SettingsHolderClassValidator
extends Object

Validates various characteristics of the property implementations of SettingsHolder classes for consistency. Finds potential technical or quality issues with a project's property declarations. This class is intended to be used in a unit test.

This class's methods can be overridden for custom behavior. Depending on your needs, you can call the main validate method and override single validation methods you want to customize or disable, or call the individual validation methods separately.

Constructor Summary

Constructors

Constructor and Description
SettingsHolderClassValidator()

Method Summary

Modifier and Type	Method and Description
protected @NotNull ConfigurationData	createConfigurationData(@NotNull Iterable<Class<? extends SettingsHolder>> classes)
protected @NotNull Predicate<String>	createValidLengthPredicate(@Nullable Integer minLength, @Nullable Integer maxLength) 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.
protected @NotNull List<String>	gatherExpectedEnumNames(@NotNull Class<? extends Enum<?>> enumClass)
protected @NotNull Stream<Field>	getAllFields(@NotNull Class<?> clazz) Returns all fields of the class, including all fields of parent classes, recursively.
protected @Nullable Class<? extends Enum<?>>	getEnumTypeOfProperty(@NotNull Property<?> property) Returns the type of the given property if it is an enum, otherwise null.
protected boolean	hasNonEmptyComment(@Nullable List<String> comments)
protected boolean	hasValidConstructorSetup(@NotNull Class<? extends SettingsHolder> clazz)
protected boolean	isValidConstantField(@NotNull Field field)
void	validate(Class<? extends SettingsHolder>... settingHolders) Runs all validations of this class with the given settings holder classes.
void	validate(@NotNull Iterable<Class<? extends SettingsHolder>> settingHolders) Runs all validations of this class with the given settings holder classes.
void	validateAllPropertiesAreConstants(@NotNull Iterable<Class<? extends SettingsHolder>> settingHolders) Throws an exception if any Property field of the given classes is not public, static, or final.
void	validateClassesHaveHiddenNoArgConstructor(@NotNull Iterable<Class<? extends SettingsHolder>> settingHolders) Throws an exception if any of the provided setting holder classes does not have a single private no-args constructor.
void	validateCommentLengthsAreWithinBounds(@NotNull ConfigurationData configurationData, @Nullable Integer minLength, @Nullable 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	validateConfigurationDataValidForMigrationService(@NotNull ConfigurationData configurationData, @NotNull PropertyResource resource, @NotNull 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	validateHasAllEnumEntriesInComment(@NotNull ConfigurationData configurationData, @Nullable Predicate<Property<?>> propertyFilter) Throws an exception if the comments of an enum property do not list all entries of the enum type.
void	validateHasCommentOnEveryProperty(@NotNull ConfigurationData configurationData, @Nullable Predicate<Property<?>> propertyFilter) Throws an exception if there isn't a non-empty comment for every property in the configuration data.
void	validateSettingsHolderClassesFinal(@NotNull Iterable<Class<? extends SettingsHolder>> settingHolders) Throws an exception if any of the provided settings holder classes is not final.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SettingsHolderClassValidator

public SettingsHolderClassValidator()

Method Detail

validate

@SafeVarargs
public final void validate(@NotNull
                                        Class<? extends SettingsHolder>... settingHolders)

Runs all validations of this class with the given settings holder classes. More details at validate(Iterable).

Parameters:

settingHolders - settings holder classes that make up the configuration data of the project

validate

public void validate(@NotNull
                     @NotNull Iterable<Class<? extends SettingsHolder>> settingHolders)

Runs all validations of this class with the given settings holder classes. Some of the validations are not needed from a technical point of view and may be undesired in your project. They can all be run individually and can be customized by supplying different method parameters or by overriding methods in this class.

Parameters:

settingHolders - settings holder classes that make up the configuration data of the project

validateConfigurationDataValidForMigrationService

public void validateConfigurationDataValidForMigrationService(@NotNull
                                                              @NotNull ConfigurationData configurationData,
                                                              @NotNull
                                                              @NotNull PropertyResource resource,
                                                              @NotNull
                                                              @NotNull 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. This is intended to validate that the default values of a configuration do not trigger a migration:

• the configuration data should only have default values
• the resource should only be for this method and thus use a temporary file

Parameters:

configurationData - the configuration data (with default values, i.e. as created from the properties)

resource - property resource to save to and read from (temporary medium for testing)

migrationService - the migration service to check

validateAllPropertiesAreConstants

public void validateAllPropertiesAreConstants(@NotNull
                                              @NotNull Iterable<Class<? extends SettingsHolder>> settingHolders)

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

Parameters:

settingHolders - the classes to check

validateSettingsHolderClassesFinal

public void validateSettingsHolderClassesFinal(@NotNull
                                               @NotNull Iterable<Class<? extends SettingsHolder>> settingHolders)

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

Parameters:

settingHolders - the classes to check

validateClassesHaveHiddenNoArgConstructor

public void validateClassesHaveHiddenNoArgConstructor(@NotNull
                                                      @NotNull Iterable<Class<? extends SettingsHolder>> settingHolders)

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

Parameters:

settingHolders - the classes to check

validateHasCommentOnEveryProperty

public void validateHasCommentOnEveryProperty(@NotNull
                                              @NotNull ConfigurationData configurationData,
                                              @Nullable
                                              @Nullable Predicate<Property<?>> propertyFilter)

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

Parameters:

configurationData - the configuration data to check

propertyFilter - predicate determining which properties are checked (if null, are properties are checked)

validateCommentLengthsAreWithinBounds

public void validateCommentLengthsAreWithinBounds(@NotNull
                                                  @NotNull ConfigurationData configurationData,
                                                  @Nullable
                                                  @Nullable Integer minLength,
                                                  @Nullable
                                                  @Nullable 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. Either argument is nullable if no min or max, respectively, is desired, but both arguments may not be null.

Parameters:

configurationData - the configuration data with the comments to check

minLength - the number of characters each comment line must at least have (null to disable check)

maxLength - the number of characters each comment may not surpass (null to disable check)

validateHasAllEnumEntriesInComment

public void validateHasAllEnumEntriesInComment(@NotNull
                                               @NotNull ConfigurationData configurationData,
                                               @Nullable
                                               @Nullable Predicate<Property<?>> propertyFilter)

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

Parameters:

configurationData - the configuration data whose properties and comments should be checked

propertyFilter - predicate determining which properties are checked (if null, are properties are checked)

isValidConstantField

protected boolean isValidConstantField(@NotNull
                                       @NotNull Field field)

createConfigurationData

@NotNull
protected @NotNull ConfigurationData createConfigurationData(@NotNull
                                                                      @NotNull Iterable<Class<? extends SettingsHolder>> classes)

hasNonEmptyComment

protected boolean hasNonEmptyComment(@Nullable
                                     @Nullable List<String> comments)

createValidLengthPredicate

@NotNull
protected @NotNull Predicate<String> createValidLengthPredicate(@Nullable
                                                                         @Nullable Integer minLength,
                                                                         @Nullable
                                                                         @Nullable Integer maxLength)

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. Either length may be null, but an exception is thrown if both are null.

Parameters:

minLength - the min length (nullable)

maxLength - the max length (nullable)

Returns:

predicate based on the supplied length parameters

getEnumTypeOfProperty

@Nullable
protected @Nullable Class<? extends Enum<?>> getEnumTypeOfProperty(@NotNull
                                                                             @NotNull Property<?> property)

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

Parameters:

property - the property to process

Returns:

the enum type it wraps, or null if not applicable

gatherExpectedEnumNames

@NotNull
protected @NotNull List<String> gatherExpectedEnumNames(@NotNull
                                                                 @NotNull Class<? extends Enum<?>> enumClass)

hasValidConstructorSetup

protected boolean hasValidConstructorSetup(@NotNull
                                           @NotNull Class<? extends SettingsHolder> clazz)

getAllFields

@NotNull
protected @NotNull Stream<Field> getAllFields(@NotNull
                                                       @NotNull Class<?> clazz)

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

Parameters:

clazz - the class whose fields should be retrieved

Returns:

all fields of the class, including its parents