Top Description Inners Fields Constructors Methods
net.fortuna.ical4j.validate

public Class ValidationRule<T>

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
net.fortuna.ical4j.util.CompatibilityHints, java.io.Serializable, java.util.Arrays, .List, java.util.function.Predicate

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.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum

Field Summary

Modifier and TypeField and Description
private final List<String>
private final String
private final Predicate<T>
private final boolean
private final ValidationRule.ValidationType

Constructor Summary

AccessConstructor and Description
public
public
ValidationRule(ValidationRule.ValidationType
rule type
type
,
String...
list of identifiers to check (parameter, property, component, etc.)
instances
)

public
ValidationRule(ValidationRule.ValidationType
rule type
type
,
boolean
indicates if rule can be ignored when relaxed mode is enabled
relaxedModeSupported
,
String...
list of identifiers to check (parameter, property, component, etc.)
instances
)

public
ValidationRule(Predicate<T>
a negative predicate, such that a successful test indicates a rule violation
predicate
,
String
the message used to indicate a rule violation
message
,
String...
identifiers for instances under test
instances
)

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

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

Method Summary

Modifier and TypeMethod and Description
public List<String>
public String
getMessage(String... instances)

public Predicate<T>
public ValidationEntry.Severity
public ValidationRule.ValidationType
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

instancesback to summary
private final List<String> instances
messageback to summary
private final String message
predicateback to summary
private final Predicate<T> predicate
relaxedModeSupportedback to summary
private final boolean relaxedModeSupported
typeback to summary
private final ValidationRule.ValidationType type

Constructor Detail

ValidationRuleback to summary
public ValidationRule(ValidationRule.ValidationType type, Enum<?>... instances)
ValidationRuleback to summary
public ValidationRule(ValidationRule.ValidationType type, String... instances)
Parameters
type:ValidationRule.ValidationType

rule type

instances:String[]

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

ValidationRuleback to summary
public ValidationRule(ValidationRule.ValidationType type, boolean relaxedModeSupported, String... instances)
Parameters
type:ValidationRule.ValidationType

rule type

relaxedModeSupported:boolean

indicates if rule can be ignored when relaxed mode is enabled

instances:String[]

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

ValidationRuleback to summary
public ValidationRule(Predicate<T> predicate, String message, String... instances)
Parameters
predicate:Predicate<T>

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

message:String

the message used to indicate a rule violation

instances:String[]

identifiers for instances under test

ValidationRuleback to summary
public ValidationRule(Predicate<T> predicate, String message, boolean relaxedModeSupported, String... instances)
ValidationRuleback to summary
private ValidationRule(ValidationRule.ValidationType type, Predicate<T> predicate, String message, boolean relaxedModeSupported, String... instances)

Method Detail

getInstancesback to summary
public List<String> getInstances()
getMessageback to summary
public String getMessage(String... instances)
getPredicateback to summary
public Predicate<T> getPredicate()
getSeverityback to summary
public ValidationEntry.Severity getSeverity()
getTypeback to summary
public ValidationRule.ValidationType getType()
net.fortuna.ical4j.validate back to summary

public final Enum ValidationRule.ValidationType

extends Enum<ValidationRule.ValidationType>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final ValidationRule.ValidationType
private final String
public static final ValidationRule.ValidationType
public static final ValidationRule.ValidationType
public static final ValidationRule.ValidationType
public static final ValidationRule.ValidationType
public static final ValidationRule.ValidationType
public static final ValidationRule.ValidationType

Constructor Summary

AccessConstructor and Description
private
ValidationType(String description)

Method Summary

Modifier and TypeMethod and Description
public String
public static ValidationRule.ValidationType
public static ValidationRule.ValidationType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

AllOrNoneback to summary
public static final ValidationRule.ValidationType AllOrNone
descriptionback to summary
private final String description
Noneback to summary
public static final ValidationRule.ValidationType None
Oneback to summary
public static final ValidationRule.ValidationType One
OneExclusiveback to summary
public static final ValidationRule.ValidationType OneExclusive
OneOrLessback to summary
public static final ValidationRule.ValidationType OneOrLess
OneOrMoreback to summary
public static final ValidationRule.ValidationType OneOrMore
ValueMatchback to summary
public static final ValidationRule.ValidationType ValueMatch

Constructor Detail

ValidationTypeback to summary
private ValidationType(String description)

Method Detail

getDescriptionback to summary
public String getDescription()
valueOfback to summary
public static ValidationRule.ValidationType valueOf(String name)
valuesback to summary
public static ValidationRule.ValidationType[] values()