Class XSBase64Binary

java.lang.Object

org.exolab.castor.builder.types.XSType

org.exolab.castor.builder.types.AbstractPatternFacet

org.exolab.castor.builder.types.AbstractWhiteSpaceFacet

org.exolab.castor.builder.types.AbstractLengthFacet

org.exolab.castor.builder.types.XSBase64Binary

public final class XSBase64Binary
extends AbstractLengthFacet

The xsd:base64Binary XML Schema datatype.

Since:

1.1

Version:

$Revision: 6623 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $

Author:

Ralf Joachim

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	Name of this XSType.
static final short	TYPE	Type number of this XSType.

Fields inherited from class 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

Modifier and Type	Field	Description
static final short	ANYURI_TYPE	xsd:anyURI.
static final short	BASE64BINARY_TYPE	xsd:base64Binary.
static final short	BOOLEAN_TYPE	xsd:boolean.
static final short	BYTE_TYPE	xsd:byte.
static final short	CLASS	A user-defined type.
static final short	COLLECTION	A collection type.
static final short	DATE_TYPE	xsd:date.
static final short	DATETIME_TYPE	xsd:dateTime.
static final short	DECIMAL_TYPE	xsd:decimal.
static final short	DOUBLE_TYPE	xsd:double.
static final short	DURATION_TYPE	xsd:duration.
static final short	ENTITIES	xsd:ENTITIES.
static final short	ENTITY	xsd:ENTITY.
static final short	FLOAT_TYPE	xsd:float.
static final short	GDAY_TYPE	xsd:gDay.
static final short	GMONTH_TYPE	xsd:gMonth.
static final short	GMONTHDAY_TYPE	xsd:gMonthDay.
static final short	GYEAR_TYPE	xsd:gYear.
static final short	GYEARMONTH_TYPE	xsd:gYearMonth.
static final short	HEXBINARY_TYPE	xsd:hexBinary.
static final short	ID_TYPE	xsd:ID.
static final short	IDREF_TYPE	xsd:IDREF.
static final short	IDREFS_TYPE	xsd:IDREFS.
static final short	INT_TYPE	xsd:int.
static final short	INTEGER_TYPE	xsd:integer.
static final short	LANGUAGE_TYPE	xsd:language.
static final short	LONG_TYPE	xsd:long.
static final short	NAME_TYPE	xsd:name.
static final short	NCNAME_TYPE	xsd:NCNAME.
static final short	NEGATIVE_INTEGER_TYPE	xsd:negativeInteger.
static final short	NMTOKEN_TYPE	xsd:NMTOKEN.
static final short	NMTOKENS_TYPE	xsd:NMTOKENS.
static final short	NON_NEGATIVE_INTEGER_TYPE	xsd:nonNegativeInteger.
static final short	NON_POSITIVE_INTEGER_TYPE	xsd:nonPositiveInteger.
static final short	NORMALIZEDSTRING_TYPE	xsd:normalizedString.
static final short	NOTATION_TYPE	xsd:notation.
static final short	NULL	Value meaning the type is unassigned.
static final short	POSITIVE_INTEGER_TYPE	xsd:positiveInteger.
static final short	QNAME_TYPE	xsd:QName.
static final short	SHORT_TYPE	xsd:short.
static final short	STRING_TYPE	xsd:string.
static final short	TIME_TYPE	xsd:time.
static final short	TOKEN_TYPE	xsd:token.
static final short	UNSIGNED_BYTE_TYPE	xsd:unsignedByte.
static final short	UNSIGNED_INT_TYPE	xsd:unsignedInt.
static final short	UNSIGNED_LONG_TYPE	xsd:unsignedLong.
static final short	UNSIGNED_SHORT_TYPE	xsd:unsignedShort.

Constructor Summary

Constructors

Constructor	Description
XSBase64Binary(boolean useJava50)	Create a new XSBase64Binary object.

Method Summary

Modifier and Type	Method	Description
String	createFromJavaObjectCode(String variableName)	Returns the string necessary to convert an Object to an instance of this XSType.
String	createToJavaObjectCode(String variableName)	Returns the string necessary to convert an instance of this XSType to an Object.
JType	getJType()	Returns the JType that this XSType represents.
String	getName()	Returns the name of this XSType.
short	getType()	Returns the type of this XSType.
boolean	isDateTime()	Returns true if the XSType represents an XML Schema date/time type.
boolean	isPrimitive()	Returns true if this XSType represents a primitive type.
String	newInstanceCode()	Returns the Java code neccessary to create a new instance of the JType associated with this XSType.
void	validationCode(JSourceCode jsc, String fixedValue, String validatorInstanceName)	Creates the validation code for an instance of this XSType.

Methods inherited from class AbstractLengthFacet

codeLengthFacet, getLength, getMaxLength, getMinLength, hasLength, hasMaxLength, hasMinLength, setFacet, setLength, setLengthFacet, setMaxLength, setMinLength

Modifier and Type	Method	Description
protected final void	codeLengthFacet(JSourceCode jsc, String validatorName)	Generate the source code for length, maxLength or minLength facets validation.
final int	getLength()	Returns the length that this type must have.
final int	getMaxLength()	Returns the maximum length occurances of this type can be.
final int	getMinLength()	Returns the minimum length occurances of this type can be.
final boolean	hasLength()	Returns true if a length has been set.
final boolean	hasMaxLength()	Returns true if a maximum length has been set.
final boolean	hasMinLength()	Returns true if a minimum length has been set.
protected final void	setFacet(Facet facet)	Set the given facet for XSType if applicable.
final void	setLength(int length)	Sets the length of this type.
protected final void	setLengthFacet(Facet facet)	Transfer given facet if it is one of length, maxLength or minLength.
final void	setMaxLength(int maxLength)	Sets the maximum length of this type.
final void	setMinLength(int minLength)	Sets the minimum length of this XSString.

Methods inherited from class AbstractWhiteSpaceFacet

codeWhiteSpaceFacet, getWhiteSpace, hasWhiteSpace, setWhiteSpace, setWhiteSpaceFacet

Modifier and Type	Method	Description
protected final void	codeWhiteSpaceFacet(JSourceCode jsc, String validatorName)	Generate the source code for pattern facet validation.
final String	getWhiteSpace()	Returns the whiteSpace facet of this type.
final boolean	hasWhiteSpace()	Returns true if the whiteSpace facet is used.
final void	setWhiteSpace(String value)	Sets the whiteSpace facet of this XSType.
protected final void	setWhiteSpaceFacet(Facet facet)	Transfer given facet if it is a whiteSpace.

Methods inherited from class AbstractPatternFacet

addPattern, addPatternFacet, codePatternFacet, getPatterns

Modifier and Type	Method	Description
final void	addPattern(String pattern)	Adds a pattern branch for this XSType.
protected final void	addPatternFacet(Facet facet)	Transfer given facet if it is a pattern.
protected final void	codePatternFacet(JSourceCode jsc, String validatorName)	Generate the source code for pattern facet validation.
final List<String>	getPatterns()	Get list of pattern facets.

Methods inherited from class XSType

createDefaultValueWithString, isCollection, isEnumerated, setAsEnumerated, setFacets

Modifier and Type	Method	Description
String	createDefaultValueWithString(String variableName)	Creates source code for an additional constructor that deals with default values as specified in the XML schema instance.
boolean	isCollection()	Returns true if this XSType represents a collection.
final boolean	isEnumerated()	Returns true if this XSType represents an enumerated type.
final void	setAsEnumerated(boolean enumerated)	Sets the enumerated flag for this XSClass.
final void	setFacets(SimpleType simpleType)	Reads and sets the facets for XSType.

Methods inherited from class Object

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

Field Details

NAME

public static final String NAME

Name of this XSType.

See Also:

• Constant Field Values

TYPE

public static final short TYPE

Type number of this XSType.

See Also:

• Constant Field Values

Constructor Details

XSBase64Binary

public XSBase64Binary(boolean useJava50)

Create a new XSBase64Binary object.

Parameters:

useJava50 - If true, Java 5 code artifacts will be generated.

Method Details

getName

public String getName()

Returns the name of this XSType.

Specified by:

getName in class XSType

Returns:

The name of this XSType.

getType

public short getType()

Returns the type of this XSType.

Specified by:

getType in class XSType

Returns:

the type of this XSType.

isPrimitive

public boolean isPrimitive()

Returns true if this XSType represents a primitive type.

Specified by:

isPrimitive in class XSType

Returns:

True if this XSType represents a primitive type.

isDateTime

public boolean isDateTime()

Returns true if the XSType represents an XML Schema date/time type.

Specified by:

isDateTime in class XSType

Returns:

True if the XSType represents an XML Schema date/time type.

getJType

public JType getJType()

Returns the JType that this XSType represents.

Specified by:

getJType in class XSType

Returns:

The JType that this XSType represents.

newInstanceCode

public String newInstanceCode()

Returns the Java code neccessary to create a new instance of the JType associated with this XSType.

Specified by:

newInstanceCode in class XSType

Returns:

The Java code neccessary to create a new instance.

createToJavaObjectCode

public String createToJavaObjectCode(String variableName)

Returns the string necessary to convert an instance of this XSType to an Object. This method is really only useful for primitive types.

Specified by:

createToJavaObjectCode in class XSType

Parameters:

variableName - The name of the instance variable.

Returns:

The String necessary to convert an instance of this XSType to an Object.

createFromJavaObjectCode

public String createFromJavaObjectCode(String variableName)

Returns the string necessary to convert an Object to an instance of this XSType. This method is really only useful for primitive types.

Specified by:

createFromJavaObjectCode in class XSType

Parameters:

variableName - The name of the Object.

Returns:

The String necessary to convert an Object to an instance of this XSType.

validationCode

public void validationCode(JSourceCode jsc,
 String fixedValue,
 String validatorInstanceName)

Creates the validation code for an instance of this XSType. If necessary the validation code should create a newly configured TypeValidator, that should then be added to a FieldValidator instance whose name is provided.

Specified by:

validationCode in class XSType

Parameters:

jsc - The JSourceCode to fill in.

fixedValue - A fixed value to use if any.

validatorInstanceName - The name of the FieldValidator that the configured TypeValidator should be added to.