Skip to content
Snippets Groups Projects
Commit 473aef92 authored by Leonard Kupper's avatar Leonard Kupper
Browse files

Add javadoc description for new property definition methods.

parent f8e93698
No related branches found
No related tags found
1 merge request!9Feat/configparser update 18
...@@ -69,15 +69,39 @@ class JavaPropertiesConfigurationValidator implements ConfigurationValidator { ...@@ -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) { private void definePrinterProperty(final String propertyName, final Predicate<String> validation) {
definePrinterProperty(propertyName, validation, true); 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}&lt;{@link String}&gt;
* @param required Signals whether this is a required property or not.
*/
private void definePrinterProperty(final String propertyName, final Predicate<String> validation, final boolean required) { private void definePrinterProperty(final String propertyName, final Predicate<String> validation, final boolean required) {
defineProperty(mValidPrinterProperties, propertyName, validation, required, mRequiredPrinterProperties); 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}&lt;{@link String}&gt;
*/
private void defineFormatProperty(final String propertyName, final Predicate<String> validation) { private void defineFormatProperty(final String propertyName, final Predicate<String> validation) {
defineFormatProperty(propertyName, validation, true); 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}&lt;{@link String}&gt;
* @param required Signals whether this is a required property or not.
*/
private void defineFormatProperty(final String propertyName, final Predicate<String> validation, final boolean required) { private void defineFormatProperty(final String propertyName, final Predicate<String> validation, final boolean required) {
defineProperty(mValidFormatProperties, propertyName, validation, required, mRequiredFormatProperties); defineProperty(mValidFormatProperties, propertyName, validation, required, mRequiredFormatProperties);
} }
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment