com.hp.util.syntax.parsers

Class StringListConstraints

java.lang.Object

com.hp.util.syntax.parsers.StringConstraints

com.hp.util.syntax.parsers.StringListConstraints

All Implemented Interfaces:

Constraints, ListConstraints

public class StringListConstraints
extends StringConstraints
implements ListConstraints

Builtin constraints validator for a list of string values.

Author:

Thomas Vachuska

Field Summary

Fields inherited from class com.hp.util.syntax.parsers.StringConstraints

illegalERE, illegalValues, legalERE, legalValues, max, min

Fields inherited from interface com.hp.util.syntax.parsers.ListConstraints

KW_MAX_LENGTH, KW_MIN_LENGTH, KW_SEPARATOR, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
StringListConstraints() Default constructor.
StringListConstraints(String min, String max, String legalValues, String illegalValues, String legalERE, String illegalERE, String separator, Integer minLength, Integer maxLength) Creates a constraints validator for lists of strings.

Method Summary

Methods

Modifier and Type	Method and Description
Integer	getMaxLength() Returns the maximum length of the list or null of there is not one.
Integer	getMinLength() Returns the minimum length of the list or null of there is not one.
String	getSeparator() Returns the character used as the item separator.

Methods inherited from class com.hp.util.syntax.parsers.StringConstraints

isValid

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hp.util.syntax.parsers.Constraints

isValid

Constructor Detail

StringListConstraints

public StringListConstraints()

Default constructor.

StringListConstraints

public StringListConstraints(String min,
                     String max,
                     String legalValues,
                     String illegalValues,
                     String legalERE,
                     String illegalERE,
                     String separator,
                     Integer minLength,
                     Integer maxLength)

Creates a constraints validator for lists of strings.

Parameters:

min - If not null, it specifies the minimum lexicographical value the individual parsed argument can have to be a valid parameter.

max - If not null, it specifies the maximum lexicographical value the individual parsed argument can have to be a valid parameter.

legalValues - A string-set token, listing all legal values that the individual parsed argument can take on. The values in the set are separated via the pipe (|) character and abbreviated values can be specified using the asterisk (*) character.

illegalValues - A string-set token, listing all illegal values that the individual parsed argument cannot take on. The values in the set are separated via the pipe (|) character and abbreviated values can be specified using the asterisk (*) character.

legalERE - Regular expression which the parameter must match, or null.

illegalERE - Regular expression which the parameter must not match, or null.

separator - Single character delimiter for list items.

minLength - Minimum length of the list of string tokens.

maxLength - Maximum length of the list of string tokens.

Method Detail

getSeparator

public String getSeparator()

Description copied from interface: ListConstraints

Returns the character used as the item separator.

Specified by:

getSeparator in interface ListConstraints

Returns:

item separator string

See Also:

ListConstraints.getSeparator()

getMinLength

public Integer getMinLength()

Description copied from interface: ListConstraints

Returns the minimum length of the list or null of there is not one.

Specified by:

getMinLength in interface ListConstraints

Returns:

minimum list length

See Also:

ListConstraints.getMinLength()

getMaxLength

public Integer getMaxLength()

Description copied from interface: ListConstraints

Returns the maximum length of the list or null of there is not one.

Specified by:

getMaxLength in interface ListConstraints

Returns:

maximum list length

See Also:

ListConstraints.getMaxLength()