Class NameValidator

java.lang.Object

org.exolab.castor.xml.validators.PatternValidator

org.exolab.castor.xml.validators.StringValidator

org.exolab.castor.xml.validators.NameValidator

All Implemented Interfaces:

TypeValidator

public class NameValidator
extends StringValidator

The Name Validation class. This class handles validation for XML Name production types such as NCName and NMToken

Version:

$Revision: 6605 $ $Date: 2005-12-13 14:58:48 -0700 (Tue, 13 Dec 2005) $

Author:

Keith Visco

Field Summary

Fields

Modifier and Type	Field	Description
static final short	CDATA	XML name type CDATA.
static final short	NCNAME	XML name type NCName.
static final short	NMTOKEN	XML name type NMTOKEN.

Fields inherited from class PatternValidator

resourceBundle

Modifier and Type	Field	Description
protected static ResourceBundle	resourceBundle

Constructor Summary

Constructors

Constructor	Description
NameValidator()	Creates a new NameValidator with the default validation set to NCName.
NameValidator(short type)	Creates a new NameValidator with the given validation type.

Method Summary

Modifier and Type	Method	Description
void	setRequired(boolean required)	Sets whether or not a String is required (non null).
void	validate(Object object)	Validates the given Object.
void	validate(Object object, ValidationContext context)	Validates the given Object.
void	validate(String value, ValidationContext context)	Validates the given Object.

Methods inherited from class StringValidator

clearFixed, normalize, setFixed, setFixedValue, setLength, setMaxLength, setMinLength, setWhiteSpace

Modifier and Type	Method	Description
void	clearFixed()	Clears the fixed value for this ShortValidator.
String	normalize(String value)	Normalizes the given string according to the whiteSpace facet used.
void	setFixed(String fixedValue)	Sets the fixed value in which all valid Strings must match.
void	setFixedValue(String fixedValue)	Deprecated. since 0.9.4_beta
void	setLength(int length)	Sets the required string length for String validation.
void	setMaxLength(int maxLength)	Sets the maximum string length for String validation.
void	setMinLength(int minLength)	Sets the minimum string length for String validation.
void	setWhiteSpace(String value)	Sets the whiteSpace facet of the validator.

Methods inherited from class PatternValidator

addPattern, clearPatterns, getPatterns, hasPattern, isNillable, setNillable

Modifier and Type	Method	Description
void	addPattern(String pattern)	Sets the regular expression to validate against.
void	clearPatterns()	Clear all configured patterns.
List<String>	getPatterns()	Returns the collection of regular expression patterns.
boolean	hasPattern()	Returns true if a regular expression has been set for this PatternValidator.
boolean	isNillable()	Returns whether or not objects validated by this Validator are nillable (are allowed to be null).
void	setNillable(boolean nillable)	Sets whether or not objects validated by this Validator are allowed to be null (nillable).

Methods inherited from class Object

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

Field Details

NCNAME

public static final short NCNAME

XML name type NCName. @deprecated - use XMLConstants.NAME_TYPE_NCNAME. Retained for backwards-compatility.

See Also:

• Constant Field Values

NMTOKEN

public static final short NMTOKEN

XML name type NMTOKEN. @deprecated - use XMLConstants.NAME_TYPE_NCTOKEN. Retained for backwards-compatility.

See Also:

• Constant Field Values

CDATA

public static final short CDATA

XML name type CDATA. @deprecated - use XMLConstants.NAME_TYPE_CDATA. Retained for backwards-compatility.

See Also:

• Constant Field Values

Constructor Details

NameValidator

public NameValidator()

Creates a new NameValidator with the default validation set to NCName.

NameValidator

public NameValidator(short type)

Creates a new NameValidator with the given validation type.

Parameters:

type - the validation type for this NameValidator

Method Details

setRequired

public void setRequired(boolean required)

Sets whether or not a String is required (non null).

Overrides:

setRequired in class StringValidator

Parameters:

required - the flag indicating whether Strings are required

validate

public void validate(String value,
 ValidationContext context)
              throws ValidationException

Validates the given Object.

Overrides:

validate in class StringValidator

Parameters:

value - the string to validate

context - the ValidationContext

Throws:

ValidationException - if the object fails validation.

See Also:

• invalid reference

  #setPattern

validate

public void validate(Object object)
              throws ValidationException

Validates the given Object.

Overrides:

validate in class StringValidator

Parameters:

object - the Object to validate

Throws:

ValidationException - if the object fails validation.

validate

public void validate(Object object,
 ValidationContext context)
              throws ValidationException

Validates the given Object.

Specified by:

validate in interface TypeValidator

Overrides:

validate in class StringValidator

Parameters:

object - the Object to validate

context - the ValidationContext

Throws:

ValidationException - if the object fails validation.