Package org.jboss.as.controller.operations.validation

Class StringLengthValidator

java.lang.Object

org.jboss.as.controller.operations.validation.ModelTypeValidator

org.jboss.as.controller.operations.validation.StringLengthValidator

All Implemented Interfaces:

MinMaxValidator, ParameterValidator

Direct Known Subclasses:

MulticastAddressValidator, SubnetValidator, URIValidator

public class StringLengthValidator
extends ModelTypeValidator
implements MinMaxValidator

Validates that the given parameter is a string of an allowed length.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	max
protected int	min

Fields inherited from class org.jboss.as.controller.operations.validation.ModelTypeValidator

BIGDECIMAL_MAX, BIGDECIMAL_MIN, BIGINTEGER_MAX, BIGINTEGER_MIN, nullable, strictType, validTypes

Constructor Summary

Constructors

Constructor	Description
StringLengthValidator(int min)	Equivalent to this(min, Integer.MAX_VALUE, false, false).
StringLengthValidator(int min, boolean nullable)	Equivalent to this(min, Integer.MAX_VALUE, nullable, false).
StringLengthValidator(int min, boolean nullable, boolean allowExpressions)	Equivalent to this(min, Integer.MAX_VALUE, nullable, allowExpressions).
StringLengthValidator(int min, int max)
StringLengthValidator(int min, int max, boolean nullable, boolean allowExpressions)	Creates a new StringLengthValidator.

Method Summary

Modifier and Type	Method	Description
Long	getMax()	Gets the maximum, if there is one.
Long	getMin()	Gets the minimum, if there is one.
void	validateParameter(String parameterName, org.jboss.dmr.ModelNode value)	Validate the parameter with the given name.

Methods inherited from class java.lang.Object

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

Field Detail

min

protected final int min

max

protected final int max

Constructor Detail

StringLengthValidator

public StringLengthValidator(int min)

Equivalent to this(min, Integer.MAX_VALUE, false, false).

Parameters:

min - the minimum length of the string

StringLengthValidator

public StringLengthValidator(int min,
                             int max)

StringLengthValidator

public StringLengthValidator(int min,
                             boolean nullable)

Equivalent to this(min, Integer.MAX_VALUE, nullable, false).

Parameters:

min - the minimum length of the string

nullable - true is an ModelType.UNDEFINED value is valid

StringLengthValidator

public StringLengthValidator(int min,
                             int max,
                             boolean nullable,
                             boolean allowExpressions)

Creates a new StringLengthValidator.

Parameters:

min - the minimum length of the string

max - the maximum length of the string

nullable - true if an ModelType.UNDEFINED value is valid

allowExpressions - true if an ModelType.EXPRESSION value is valid

StringLengthValidator

public StringLengthValidator(int min,
                             boolean nullable,
                             boolean allowExpressions)

Equivalent to this(min, Integer.MAX_VALUE, nullable, allowExpressions).

Parameters:

min - the minimum length of the string

nullable - true if an ModelType.UNDEFINED value is valid

allowExpressions - true if an ModelType.EXPRESSION value is valid

Method Detail

validateParameter

public void validateParameter(String parameterName,
                              org.jboss.dmr.ModelNode value)
                       throws OperationFailedException

Validate the parameter with the given name.

Specified by:

validateParameter in interface ParameterValidator

Overrides:

validateParameter in class ModelTypeValidator

Parameters:

parameterName - the name of the parameter. Cannot be null

value - the parameter value. Cannot be null

Throws:

OperationFailedException - if the value is not valid

getMin

public Long getMin()

Description copied from interface: MinMaxValidator

Gets the minimum, if there is one.

Specified by:

getMin in interface MinMaxValidator

Returns:

the minimum value, or null if there is no minimum

getMax

public Long getMax()

Description copied from interface: MinMaxValidator

Gets the maximum, if there is one.

Specified by:

getMax in interface MinMaxValidator

Returns:

the maximum value, or null if there is no minimum