From 22b5f900ffdd4a543224724fb76f88bdacfccb55 Mon Sep 17 00:00:00 2001 From: Ben Fortuna Date: Sat, 23 Oct 2021 15:38:02 +1100 Subject: [PATCH] Updated docs --- .../java/net/fortuna/ical4j/validate/ValidationRule.java | 7 +++++++ src/main/java/net/fortuna/ical4j/validate/Validator.java | 9 ++++++--- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/src/main/java/net/fortuna/ical4j/validate/ValidationRule.java b/src/main/java/net/fortuna/ical4j/validate/ValidationRule.java index e77b1ab57..ef34f6fae 100644 --- a/src/main/java/net/fortuna/ical4j/validate/ValidationRule.java +++ b/src/main/java/net/fortuna/ical4j/validate/ValidationRule.java @@ -4,6 +4,13 @@ import java.util.Arrays; import java.util.List; +/** + * Defines a rule for validating iCalendar content. A rule consists of a validation type (e.g. presence/absence of + * specific content), and one or more identifiers (names) of iCalendar content. + * + * For example, a rule might define a test for one or less DTEND properties using the "OneOrLess" validation type + * and "DTEND" identifier. + */ public class ValidationRule implements Serializable { public enum ValidationType { None, One, OneOrLess, OneOrMore } diff --git a/src/main/java/net/fortuna/ical4j/validate/Validator.java b/src/main/java/net/fortuna/ical4j/validate/Validator.java index d35ee27aa..6fa309ed8 100644 --- a/src/main/java/net/fortuna/ical4j/validate/Validator.java +++ b/src/main/java/net/fortuna/ical4j/validate/Validator.java @@ -38,8 +38,10 @@ import java.util.function.Predicate; /** - * @author fortuna + * Implementors apply validation rules to iCalendar content to determine a level of compliance with the published + * specifications. * + * @author fortuna */ public interface Validator extends Serializable { @@ -56,8 +58,9 @@ static void assertFalse(Predicate predicate, String message, boolean warn } /** - * Validates the associated model against an applicable standard. - * @throws ValidationException where the model does not confirm to the applicable standard + * Validates the target content by applying validation rules. When content fails validation the validator + * may throw an exception depending on the implementation. + * @throws ValidationException indicates validation failure (implementation-specific) */ void validate(T target) throws ValidationException; }