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

Class ValidationOptions.Builder

java.lang.Object

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

All Implemented Interfaces:

org.apache.commons.lang3.builder.Builder<IValidationOptions>

Enclosing class:

ValidationOptions

public static class ValidationOptions.Builder
extends Object
implements org.apache.commons.lang3.builder.Builder<IValidationOptions>

Builder for configuring an IValidationOptions object.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ValidationOptions.Builder	addKnownVariables(Iterable<String> variableNames)
ValidationOptions.Builder	addKnownVariables(String... variableNames)
IValidationOptions	build()
ValidationOptions.Builder	locale(Locale locale)
ValidationOptions.Builder	treatExtraneousVariablesAsError(boolean treatExtraneousVariablesAsError)
ValidationOptions.Builder	treatNonExistingVariablesAsError(boolean treatNonExistingVariablesAsError)
ValidationOptions.Builder	variableExistenceCheck(Function<String,Boolean> check)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

addKnownVariables

public ValidationOptions.Builder addKnownVariables(Iterable<String> variableNames)

Parameters:

variableNames - Variable names to add to the list of all variables that are definitely known to exist. Note that this is overridden by the result of ValidationOptions.getVariableExistenceCheck() when that return a non-null value.

Returns:

this for chaining.

addKnownVariables

public ValidationOptions.Builder addKnownVariables(String... variableNames)

Parameters:

variableNames - Variable names to add to the list of all variables that are definitely known to exist. Note that this is overridden by the result of ValidationOptions.getVariableExistenceCheck() when that return a non-null value.

Returns:

this for chaining.

build

public IValidationOptions build()

Specified by:

build in interface org.apache.commons.lang3.builder.Builder<IValidationOptions>

locale

public ValidationOptions.Builder locale(Locale locale)

Parameters:

locale - Locale used for localizing validation messages.

Returns:

this for chaining.

treatExtraneousVariablesAsError

public ValidationOptions.Builder treatExtraneousVariablesAsError(boolean treatExtraneousVariablesAsError)

Parameters:

treatExtraneousVariablesAsError - 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.

Returns:

this for chaining.

treatNonExistingVariablesAsError

public ValidationOptions.Builder treatNonExistingVariablesAsError(boolean treatNonExistingVariablesAsError)

Parameters:

treatNonExistingVariablesAsError - 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.

Returns:

this for chaining.

variableExistenceCheck

public ValidationOptions.Builder variableExistenceCheck(Function<String,Boolean> check)

Parameters:

check - 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 ValidationOptions.getKnownVariables() is used instead. When not null, the result of this check overrides the result of ValidationOptions.getKnownVariables(). Must return true when the variable exists, false when the variable does not exist, and null when not certain whether it exists.

Returns:

this for chaining.