org.opendaylight.yangtools.yang.model.util

Class BaseConstraints

java.lang.Object

org.opendaylight.yangtools.yang.model.util.BaseConstraints

public final class BaseConstraints
extends Object

Utility class which provides factory methods to construct Constraints. Provides static factory methods which constructs instances of

• LengthConstraint - newLengthConstraint(Number, Number, Optional, Optional)
• RangeConstraint - newRangeConstraint(Number, Number, Optional, Optional)
• PatternConstraint - newPatternConstraint(String, Optional, Optional)

Method Summary

Modifier and Type	Method and Description
static LengthConstraint	newLengthConstraint(Number min, Number max, com.google.common.base.Optional<String> description, com.google.common.base.Optional<String> reference) Creates a LengthConstraint.
static LengthConstraint	newLengthConstraint(Number min, Number max, com.google.common.base.Optional<String> description, com.google.common.base.Optional<String> reference, String errorAppTag, String errorMessage) Creates a LengthConstraint.
static PatternConstraint	newPatternConstraint(String pattern, com.google.common.base.Optional<String> description, com.google.common.base.Optional<String> reference) Creates a PatternConstraint.
static PatternConstraint	newPatternConstraint(String pattern, com.google.common.base.Optional<String> description, com.google.common.base.Optional<String> reference, String errorAppTag, String errorMessage, com.google.common.base.Optional<ModifierKind> modifier) Creates a PatternConstraint.
static <T extends Number> RangeConstraint	newRangeConstraint(T min, T max, com.google.common.base.Optional<String> description, com.google.common.base.Optional<String> reference) Creates a RangeConstraint.
static <T extends Number> RangeConstraint	newRangeConstraint(T min, T max, com.google.common.base.Optional<String> description, com.google.common.base.Optional<String> reference, String errorAppTag, String errorMessage) Creates a RangeConstraint.

Methods inherited from class java.lang.Object

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

Method Detail

newLengthConstraint

public static LengthConstraint newLengthConstraint(Number min,
                                                   Number max,
                                                   com.google.common.base.Optional<String> description,
                                                   com.google.common.base.Optional<String> reference)

Creates a LengthConstraint. Creates an instance of Length constraint based on supplied parameters with additional behaviour:

• ConstraintMetaDefinition.getErrorAppTag() returns length-out-of-specified-bounds
• ConstraintMetaDefinition.getErrorMessage() returns The argument is out of bounds <min, max >

Parameters:

min - length-restricting lower bound value. The value MUST NOT be negative.

max - length-restricting upper bound value. The value MUST NOT be negative.

description - Description associated with constraint. Optional.absent() if description is undefined.

reference - Reference associated with constraint. Optional.absent() if reference is undefined.

Returns:

Instance of LengthConstraint

See Also:

LengthConstraint

newLengthConstraint

public static LengthConstraint newLengthConstraint(Number min,
                                                   Number max,
                                                   com.google.common.base.Optional<String> description,
                                                   com.google.common.base.Optional<String> reference,
                                                   String errorAppTag,
                                                   String errorMessage)

Creates a LengthConstraint. Creates an instance of Length constraint based on supplied parameters with additional behaviour:

• ConstraintMetaDefinition.getErrorAppTag() returns length-out-of-specified-bounds
• ConstraintMetaDefinition.getErrorMessage() returns The argument is out of bounds <min, max >

Parameters:

min - length-restricting lower bound value. The value MUST NOT be negative.

max - length-restricting upper bound value. The value MUST NOT be negative.

description - Description associated with constraint. Optional.absent() if description is undefined.

reference - Reference associated with constraint. Optional.absent() if reference is undefined.

errorAppTag - error-app-tag associated with constraint.

errorMessage - error message associated with constraint.

Returns:

Instance of LengthConstraint

See Also:

LengthConstraint

newRangeConstraint

public static <T extends Number> RangeConstraint newRangeConstraint(T min,
                                                                    T max,
                                                                    com.google.common.base.Optional<String> description,
                                                                    com.google.common.base.Optional<String> reference)

Creates a RangeConstraint. Creates an instance of Range constraint based on supplied parameters with additional behaviour:

• ConstraintMetaDefinition.getErrorAppTag() returns range-out-of-specified-bounds
• ConstraintMetaDefinition.getErrorMessage() returns The argument is out of bounds <min, max >

Type Parameters:

T - Type of constraint

Parameters:

min - value-restricting lower bound value. The value MUST NOT Be null.

max - value-restricting upper bound value. The value MUST NOT Be null.

description - Description associated with constraint. Optional.absent() if description is undefined.

reference - Reference associated with constraint. Optional.absent() if reference is undefined.

Returns:

Instance of RangeConstraint

See Also:

RangeConstraint

newRangeConstraint

public static <T extends Number> RangeConstraint newRangeConstraint(T min,
                                                                    T max,
                                                                    com.google.common.base.Optional<String> description,
                                                                    com.google.common.base.Optional<String> reference,
                                                                    String errorAppTag,
                                                                    String errorMessage)

Creates a RangeConstraint. Creates an instance of Range constraint based on supplied parameters with additional behaviour:

• ConstraintMetaDefinition.getErrorAppTag() returns range-out-of-specified-bounds
• ConstraintMetaDefinition.getErrorMessage() returns The argument is out of bounds <min, max >

Type Parameters:

T - Type of constraint

Parameters:

min - value-restricting lower bound value. The value MUST NOT Be null.

max - value-restricting upper bound value. The value MUST NOT Be null.

description - Description associated with constraint. Optional.absent() if description is undefined.

reference - Reference associated with constraint. Optional.absent() if reference is undefined.

errorAppTag - error-app-tag associated with constraint.

errorMessage - error message associated with constraint.

Returns:

Instance of RangeConstraint

See Also:

RangeConstraint

newPatternConstraint

public static PatternConstraint newPatternConstraint(String pattern,
                                                     com.google.common.base.Optional<String> description,
                                                     com.google.common.base.Optional<String> reference)

Creates a PatternConstraint. Creates an instance of Pattern constraint based on supplied parameters with additional behaviour:

• ConstraintMetaDefinition.getErrorAppTag() returns invalid-regular-expression

Parameters:

pattern - Regular expression, MUST NOT BE null.

description - Description associated with constraint.

reference - Reference associated with constraint.

Returns:

Instance of PatternConstraint

See Also:

PatternConstraint

newPatternConstraint

public static PatternConstraint newPatternConstraint(String pattern,
                                                     com.google.common.base.Optional<String> description,
                                                     com.google.common.base.Optional<String> reference,
                                                     String errorAppTag,
                                                     String errorMessage,
                                                     com.google.common.base.Optional<ModifierKind> modifier)

Creates a PatternConstraint. Creates an instance of Pattern constraint based on supplied parameters with additional behaviour:

• ConstraintMetaDefinition.getErrorAppTag() returns invalid-regular-expression

Parameters:

pattern - Regular expression, MUST NOT BE null.

description - Description associated with constraint.

reference - Reference associated with constraint.

errorAppTag - error-app-tag associated with constraint.

errorMessage - error message associated with constraint.

modifier - Modifier of pattern constraint.

Returns:

Instance of PatternConstraint

See Also:

PatternConstraint