Class XSList

java.lang.Object

org.exolab.castor.builder.types.XSType

org.exolab.castor.builder.types.XSListType

org.exolab.castor.builder.types.XSList

public final class XSList
extends XSListType

A list type.

Version:

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

Author:

Assaf Arkin, Keith Visco, Ralf Joachim

Field Summary

Fields

Modifier and Type	Field	Description
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
XSList(String colType, XSType contentType, boolean useJava50)	Create a XSList.

Method Summary

Modifier and Type	Method	Description
short	getType()	Returns the type of this XSType.
boolean	isDerivedFromXSList()	Indicates whether this XSList instance has been created as a result of a invalid input: '<'xs:list> definition.
void	setDerivedFromXSList(boolean derivedFromXSList)	Sets whether this XSList instance has been created as a result of a invalid input: '<'xs:list> definition.
void	validationCode(JSourceCode jsc, String fixedValue, String validatorInstanceName)	Creates the validation code for an instance of this XSType.

Methods inherited from class XSListType

createFromJavaObjectCode, createToJavaObjectCode, getContentType, getJType, getMaximumSize, getMinimumSize, getName, isCollection, isDateTime, isPrimitive, newInstanceCode, setFacet, setMaximumSize, setMinimumSize

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.
final XSType	getContentType()	Returns the type contained in the list.
JType	getJType()	Returns the JType that this XSType represents.
final int	getMaximumSize()	Returns the maximum allowed size for this list.
final int	getMinimumSize()	Returns the minimum allowed size for this list.
String	getName()	Returns the name of this XSType.
boolean	isCollection()	Returns true if this XSType represents a collection.
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.
protected void	setFacet(Facet facet)	Set the given facet for XSType if applicable.
final void	setMaximumSize(int size)	Sets the maximum allowed size for this list.
final void	setMinimumSize(int size)	Sets the minimum allowed size for this list.

Methods inherited from class XSType

createDefaultValueWithString, 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.
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

TYPE

public static final short TYPE

Type number of this XSType.

See Also:

• Constant Field Values

Constructor Details

XSList

public XSList(String colType,
 XSType contentType,
 boolean useJava50)

Create a XSList.

Parameters:

colType - Type of collection to use.

contentType - Type of the collection members.

useJava50 - If true, the collection will be generated using Java 5 features such as generics.

Method Details

getType

public short getType()

Returns the type of this XSType.

Specified by:

getType in class XSType

Returns:

the type 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.

setDerivedFromXSList

public void setDerivedFromXSList(boolean derivedFromXSList)

Sets whether this XSList instance has been created as a result of a invalid input: '<'xs:list> definition.

Parameters:

derivedFromXSList - A boolean value, true or false.

isDerivedFromXSList

public boolean isDerivedFromXSList()

Indicates whether this XSList instance has been created as a result of a invalid input: '<'xs:list> definition.

Parameters:

derivedFromXSList - True if this XSList instance has been created as a result of a invalid input: '<'xs:list> definition.