Package org.openremote.model.value

Class ValueConstraint

java.lang.Object

org.openremote.model.value.ValueConstraint

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ValueConstraint.AllowedValues, ValueConstraint.Future, ValueConstraint.FutureOrPresent, ValueConstraint.Max, ValueConstraint.Min, ValueConstraint.NotBlank, ValueConstraint.NotEmpty, ValueConstraint.NotNull, ValueConstraint.Past, ValueConstraint.PastOrPresent, ValueConstraint.Pattern, ValueConstraint.Size

public abstract class ValueConstraint
extends Object
implements Serializable

Represents a constraint to apply to a value; most are based on JSR-380 validation.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ValueConstraint.AllowedValues	The attribute value must match any of the specified values in the ValueConstraint.AllowedValues.allowedValues property.
static class	ValueConstraint.Future	The attribute value must be a java time object, java date object, a string in ISO8601 format or a number representing epoch milliseconds; the value must represent a time in the future.
static class	ValueConstraint.FutureOrPresent	The attribute value must be a java time object, java date object, a string in ISO8601 format or a number representing epoch milliseconds; the value must represent a time in the future or present.
static class	ValueConstraint.Max	The attribute value must be a number lower or equal to the specified value on the ValueConstraint.Max.max property.
static class	ValueConstraint.Min	The attribute value must be a number higher or equal to the specified value on the ValueConstraint.Min.min property.
static class	ValueConstraint.NotBlank	The attribute value must not be null and must contain at least 1 non-whitespace character.
static class	ValueConstraint.NotEmpty	The attribute value must not be null nor empty.
static class	ValueConstraint.NotNull	The attribute value must not be null.
static class	ValueConstraint.Past	The attribute value must be a java time object, java date object, a string in ISO8601 format or a number representing epoch milliseconds; the value must represent a time in the past.
static class	ValueConstraint.PastOrPresent	The attribute value must be a java time object, java date object, a string in ISO8601 format or a number representing epoch milliseconds; the value must represent a time in the past or present.
static class	ValueConstraint.Pattern	The attribute value must match the regular expression pattern described in the ValueConstraint.Pattern.regexp property.
static class	ValueConstraint.Size	The attribute value must be between the specified boundaries based on the ValueConstraint.Size.min and ValueConstraint.Size.max properties.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOWED_VALUES_MESSAGE_TEMPLATE
static final String	FUTURE_MESSAGE_TEMPLATE
static final String	FUTURE_OR_PRESENT_MESSAGE_TEMPLATE
static final String	MAX_MESSAGE_TEMPLATE
protected String	message
static final String	MIN_MESSAGE_TEMPLATE
static final String	NOT_BLANK_MESSAGE_TEMPLATE
static final String	NOT_EMPTY_MESSAGE_TEMPLATE
static final String	NOT_NULL_MESSAGE_TEMPLATE
static final String	PAST_MESSAGE_TEMPLATE
static final String	PAST_OR_PRESENT_MESSAGE_TEMPLATE
static final String	PATTERN_MESSAGE_TEMPLATE
static final String	SIZE_MESSAGE_TEMPLATE
static final String	VALUE_CONSTRAINT_INVALID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ValueConstraint(String message)

Method Summary

Modifier and Type	Method	Description
static ValueConstraint[]	constraints(ValueConstraint... constraints)
abstract boolean	evaluate(Object value, Instant now)
Optional<String>	getMessage()
abstract Map<String,Object>	getParameters()

Methods inherited from class java.lang.Object

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

Field Details

VALUE_CONSTRAINT_INVALID

public static final String VALUE_CONSTRAINT_INVALID

See Also:

• Constant Field Values

SIZE_MESSAGE_TEMPLATE

public static final String SIZE_MESSAGE_TEMPLATE

See Also:

• Constant Field Values

MIN_MESSAGE_TEMPLATE

public static final String MIN_MESSAGE_TEMPLATE

See Also:

• Constant Field Values

MAX_MESSAGE_TEMPLATE

public static final String MAX_MESSAGE_TEMPLATE

See Also:

• Constant Field Values

PATTERN_MESSAGE_TEMPLATE

public static final String PATTERN_MESSAGE_TEMPLATE

See Also:

• Constant Field Values

ALLOWED_VALUES_MESSAGE_TEMPLATE

public static final String ALLOWED_VALUES_MESSAGE_TEMPLATE

See Also:

• Constant Field Values

PAST_MESSAGE_TEMPLATE

public static final String PAST_MESSAGE_TEMPLATE

See Also:

• Constant Field Values

PAST_OR_PRESENT_MESSAGE_TEMPLATE

public static final String PAST_OR_PRESENT_MESSAGE_TEMPLATE

See Also:

• Constant Field Values

FUTURE_MESSAGE_TEMPLATE

public static final String FUTURE_MESSAGE_TEMPLATE

See Also:

• Constant Field Values

FUTURE_OR_PRESENT_MESSAGE_TEMPLATE

public static final String FUTURE_OR_PRESENT_MESSAGE_TEMPLATE

See Also:

• Constant Field Values

NOT_EMPTY_MESSAGE_TEMPLATE

public static final String NOT_EMPTY_MESSAGE_TEMPLATE

See Also:

• Constant Field Values

NOT_BLANK_MESSAGE_TEMPLATE

public static final String NOT_BLANK_MESSAGE_TEMPLATE

See Also:

• Constant Field Values

NOT_NULL_MESSAGE_TEMPLATE

public static final String NOT_NULL_MESSAGE_TEMPLATE

See Also:

• Constant Field Values

message

protected String message

Constructor Details

ValueConstraint

protected ValueConstraint(String message)

Method Details

evaluate

public abstract boolean evaluate(Object value,
 Instant now)

getParameters

public abstract Map<String,Object> getParameters()

getMessage

public Optional<String> getMessage()

constraints

public static ValueConstraint[] constraints(ValueConstraint... constraints)