org.exolab.castor.builder.types
Class AbstractWhiteSpaceFacet

java.lang.Object
  extended by org.exolab.castor.builder.types.XSType
      extended by org.exolab.castor.builder.types.AbstractPatternFacet
          extended by org.exolab.castor.builder.types.AbstractWhiteSpaceFacet
Direct Known Subclasses:
AbstractLengthFacet, AbstractRangeFacet, XSBoolean

public abstract class AbstractWhiteSpaceFacet
extends AbstractPatternFacet

A base class for types which support the whiteSpace and pattern facets.

Since:
1.1
Version:
$Revision: 6678 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $
Author:
Ralf Joachim

Field Summary
 
Fields inherited from class org.exolab.castor.builder.types.XSType
ANYURI_TYPE, BASE64BINARY_TYPE, BOOLEAN_TYPE, BYTE_TYPE, CLASS, COLLECTION, DATE_TYPE, DATETIME_TYPE, DECIMAL_TYPE, DOUBLE_TYPE, DURATION_TYPE, ENTITIES, ENTITY, FLOAT_TYPE, GDAY_TYPE, GMONTH_TYPE, GMONTHDAY_TYPE, GYEAR_TYPE, GYEARMONTH_TYPE, HEXBINARY_TYPE, ID_TYPE, IDREF_TYPE, IDREFS_TYPE, INT_TYPE, INTEGER_TYPE, LANGUAGE_TYPE, LONG_TYPE, NAME_TYPE, NCNAME_TYPE, NEGATIVE_INTEGER_TYPE, NMTOKEN_TYPE, NMTOKENS_TYPE, NON_NEGATIVE_INTEGER_TYPE, NON_POSITIVE_INTEGER_TYPE, NORMALIZEDSTRING_TYPE, NOTATION_TYPE, NULL, POSITIVE_INTEGER_TYPE, QNAME_TYPE, SHORT_TYPE, STRING_TYPE, TIME_TYPE, TOKEN_TYPE, UNSIGNED_BYTE_TYPE, UNSIGNED_INT_TYPE, UNSIGNED_LONG_TYPE, UNSIGNED_SHORT_TYPE
 
Constructor Summary
protected AbstractWhiteSpaceFacet()
          No-arg constructor.
protected AbstractWhiteSpaceFacet(boolean whiteSpaceCollapseOnly)
          Construct a new AbstractXSPatternFacet optionally allowing the whiteSpace facet to be set to 'replace' and 'preserve' values in addition to 'collaps'.
 
Method Summary
protected  void codeWhiteSpaceFacet(JSourceCode jsc, java.lang.String validatorName)
          Generate the source code for pattern facet validation.
 java.lang.String getWhiteSpace()
          Returns the whiteSpace facet of this type.
 boolean hasWhiteSpace()
          Returns true if the whiteSpace facet is used.
protected  void setFacet(Facet facet)
          Set the given facet for XSType if applicable.
 void setWhiteSpace(java.lang.String value)
          Sets the whiteSpace facet of this XSType.
protected  void setWhiteSpaceFacet(Facet facet)
          Transfer given facet if it is a whiteSpace.
 
Methods inherited from class org.exolab.castor.builder.types.AbstractPatternFacet
addPattern, addPatternFacet, codePatternFacet, getPatterns
 
Methods inherited from class org.exolab.castor.builder.types.XSType
createFromJavaObjectCode, createToJavaObjectCode, getJType, getName, getType, isCollection, isDateTime, isEnumerated, isPrimitive, newInstanceCode, setAsEnumerated, setFacets, validationCode
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractWhiteSpaceFacet

protected AbstractWhiteSpaceFacet()
No-arg constructor. By default only 'collapse' is supported for the whiteSpace facet.


AbstractWhiteSpaceFacet

protected AbstractWhiteSpaceFacet(boolean whiteSpaceCollapseOnly)
Construct a new AbstractXSPatternFacet optionally allowing the whiteSpace facet to be set to 'replace' and 'preserve' values in addition to 'collaps'.

Parameters:
whiteSpaceCollapseOnly - If set to true only 'collapse' is allowed for the whiteSpace facet. If set to false 'collaps', 'replace' and 'preserve' values are allowed for whiteSpace facet.
Method Detail

hasWhiteSpace

public final boolean hasWhiteSpace()
Returns true if the whiteSpace facet is used.

Returns:
True if the whiteSpace facet is used.

getWhiteSpace

public final java.lang.String getWhiteSpace()
Returns the whiteSpace facet of this type.

Returns:
The whiteSpace facet of this type.

setWhiteSpace

public final void setWhiteSpace(java.lang.String value)
Sets the whiteSpace facet of this XSType. The value of the whiteSpace facet must be one of the following: Any other value will generate a warning and the whiteSpace facet keeps unchanged.

Parameters:
value - The value for the whiteSpace facet.

setFacet

protected void setFacet(Facet facet)
Set the given facet for XSType if applicable.

Specified by:
setFacet in class XSType
Parameters:
facet - The facet to set for XSType.

setWhiteSpaceFacet

protected final void setWhiteSpaceFacet(Facet facet)
Transfer given facet if it is a whiteSpace.

Parameters:
facet - The facet to transfer.

codeWhiteSpaceFacet

protected final void codeWhiteSpaceFacet(JSourceCode jsc,
                                         java.lang.String validatorName)
Generate the source code for pattern facet validation.

Parameters:
jsc - The JSourceCode to fill in.
validatorName - The name of the TypeValidator that the whiteSpace should be added to.


Intalio Inc. (C) 1999-2007. All rights reserved http://www.intalio.com