diff --git a/src/main/java/de/tudresden/inf/mci/brailleplot/configparser/JavaPropertiesConfigurationValidator.java b/src/main/java/de/tudresden/inf/mci/brailleplot/configparser/JavaPropertiesConfigurationValidator.java index 06d8f40550d73c322719febbd3c62ae8fe816fe6..19d61e8b8e4e6c3315eac6857ba8f4975123e1f8 100644 --- a/src/main/java/de/tudresden/inf/mci/brailleplot/configparser/JavaPropertiesConfigurationValidator.java +++ b/src/main/java/de/tudresden/inf/mci/brailleplot/configparser/JavaPropertiesConfigurationValidator.java @@ -69,15 +69,39 @@ class JavaPropertiesConfigurationValidator implements ConfigurationValidator { } + /** + * Use this function in the validators constructor to add a printer property definition to the internal validation table. + * The property will be treated as 'required'. + * @param propertyName The name of the property. (The prefix 'printer.' must be omitted.) + * @param validation The validation predicate. {@link Predicate}<{@link String}> + */ private void definePrinterProperty(final String propertyName, final Predicate<String> validation) { definePrinterProperty(propertyName, validation, true); } + /** + * Use this function in the validators constructor to add a printer property definition to the internal validation table. + * @param propertyName The name of the property. (The prefix 'printer.' must be omitted.) + * @param validation The validation predicate. {@link Predicate}<{@link String}> + * @param required Signals whether this is a required property or not. + */ private void definePrinterProperty(final String propertyName, final Predicate<String> validation, final boolean required) { defineProperty(mValidPrinterProperties, propertyName, validation, required, mRequiredPrinterProperties); } + /** + * Use this function in the validators constructor to add a format property definition to the internal validation table. + * The property will be treated as 'required'. + * @param propertyName The name of the property. (The prefix 'format.[name].' must be omitted.) + * @param validation The validation predicate. {@link Predicate}<{@link String}> + */ private void defineFormatProperty(final String propertyName, final Predicate<String> validation) { defineFormatProperty(propertyName, validation, true); } + /** + * Use this function in the validators constructor to add a format property definition to the internal validation table. + * @param propertyName The name of the property. (The prefix 'format.[name].' must be omitted.) + * @param validation The validation predicate. {@link Predicate}<{@link String}> + * @param required Signals whether this is a required property or not. + */ private void defineFormatProperty(final String propertyName, final Predicate<String> validation, final boolean required) { defineProperty(mValidFormatProperties, propertyName, validation, required, mRequiredFormatProperties); }