Package de.xima.fc.workflow.parser.infix

Class ValidationOptions

java.lang.Object

de.xima.fc.workflow.parser.infix.ValidationOptions

All Implemented Interfaces:

IValidationOptions

public final class ValidationOptions
extends Object
implements IValidationOptions

Implementation of IValidationOptions with a builder.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ValidationOptions.Builder	Builder for configuring an IValidationOptions object.

Method Summary

Modifier and Type	Method	Description
static ValidationOptions.Builder	builder()
Set<String>	getKnownVariables()
Locale	getLocale()
Function<String,Boolean>	getVariableExistenceCheck()
boolean	isTreatExtraneousVariablesAsError()
boolean	isTreatNonExistingVariablesAsError()

Methods inherited from class java.lang.Object

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

Method Detail

getKnownVariables

public Set<String> getKnownVariables()

Specified by:

getKnownVariables in interface IValidationOptions

Returns:

All variables that are definitely known to exist. For dynamic variables you may also use IValidationOptions.getVariableExistenceCheck(). Note that this is overridden by the result of IValidationOptions.getVariableExistenceCheck() when that return a non-null value.

getLocale

public Locale getLocale()

Specified by:

getLocale in interface IValidationOptions

Returns:

Optional locale for localizing error messages. Locale.ENGLISH is used when this returns null.

getVariableExistenceCheck

public Function<String,Boolean> getVariableExistenceCheck()

Specified by:

getVariableExistenceCheck in interface IValidationOptions

Returns:

A test that, given the name of a variable, checks whether that variable exists. This can be used for dynamic variables. When this returns null, the result of IValidationOptions.getKnownVariables() is used instead. When not null, the result of this check overrides the result of IValidationOptions.getKnownVariables(). Must return true when the variable exists, false when the variable does not exist, and null when not certain whether it exists.

isTreatExtraneousVariablesAsError

public boolean isTreatExtraneousVariablesAsError()

Specified by:

isTreatExtraneousVariablesAsError in interface IValidationOptions

Returns:

true to create messages with severity FCMessage.ESeverity.ERROR when a variable is found that does not occur in the expression, or false to create messages with FCMessage.ESeverity.WARN.

isTreatNonExistingVariablesAsError

public boolean isTreatNonExistingVariablesAsError()

Specified by:

isTreatNonExistingVariablesAsError in interface IValidationOptions

Returns:

true to create messages with severity FCMessage.ESeverity.ERROR when a variable that occurs in the expression does not exist, or false to create messages with FCMessage.ESeverity.WARN.

builder

public static ValidationOptions.Builder builder()

Returns:

Creates a builder for configuring an IValidationOptions object.