Module ical4j.core

Package net.fortuna.ical4j.validate

Class ValidationRule<T>

java.lang.Object

net.fortuna.ical4j.validate.ValidationRule<T>

All Implemented Interfaces:

Serializable

public class ValidationRule<T>
extends Object
implements Serializable

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. Alternatively, a Predicate may be specified to provide additional validation beyond the presence/absence of content. For example, a predicate may be used to ensure certain date properties are DATE/DATE-TIME values. Note that the predicate must specify the negative case, such that if it evaluates true the rule fails.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ValidationRule.ValidationType

Constructor Summary

Constructors

Constructor	Description
ValidationRule(Predicate<T> predicate, String message, boolean relaxedModeSupported, String... instances)
ValidationRule(Predicate<T> predicate, String message, String... instances)
ValidationRule(ValidationRule.ValidationType type, boolean relaxedModeSupported, String... instances)
ValidationRule(ValidationRule.ValidationType type, String... instances)

Method Summary

Modifier and Type	Method	Description
List<String>	getInstances()
String	getMessage(String... instances)
Predicate<T>	getPredicate()
ValidationEntry.Severity	getSeverity()
ValidationRule.ValidationType	getType()

Methods inherited from class java.lang.Object

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

Constructor Details

ValidationRule

public ValidationRule(ValidationRule.ValidationType type,
 String... instances)

Parameters:

type - rule type

instances - list of identifiers to check (parameter, property, component, etc.)

ValidationRule

public ValidationRule(ValidationRule.ValidationType type,
 boolean relaxedModeSupported,
 String... instances)

Parameters:

type - rule type

relaxedModeSupported - indicates if rule can be ignored when relaxed mode is enabled

instances - list of identifiers to check (parameter, property, component, etc.)

ValidationRule

public ValidationRule(Predicate<T> predicate,
 String message,
 String... instances)

Parameters:

predicate - a negative predicate, such that a successful test indicates a rule violation

message - the message used to indicate a rule violation

instances - identifiers for instances under test

ValidationRule

public ValidationRule(Predicate<T> predicate,
 String message,
 boolean relaxedModeSupported,
 String... instances)

Method Details

getType

public ValidationRule.ValidationType getType()

getPredicate

public Predicate<T> getPredicate()

getInstances

public List<String> getInstances()

getMessage

public String getMessage(String... instances)

getSeverity

public ValidationEntry.Severity getSeverity()