Top Description Fields Constructors Methods
com.sun.msv.datatype.xsd

public final Class ListType

extends ConcreteType
implements Discrete
Class Inheritance
All Implemented Interfaces
com.sun.msv.datatype.xsd.Discrete
Imports
com.sun.msv.datatype.SerializationContext, org.relaxng.datatype.DatatypeException, .ValidationContext, java.util.StringTokenizer

List type. type of the value object is ListValueType.
Author
Kohsuke KAWAGUCHI

Field Summary

Modifier and TypeField and Description
public final XSDatatypeImpl
itemType

atomic base type

private static final long

Constructor Summary

AccessConstructor and Description
public
ListType(String nsUri, String newTypeName, XSDatatypeImpl itemType)

derives a new datatype from atomic datatype by list

Method Summary

Modifier and TypeMethod and Description
protected void
_checkValid(String content, ValidationContext context)

Overrides com.sun.msv.datatype.xsd.ConcreteType._checkValid.

The current implementation detects which list item is considered wrong.
public Object
_createValue(String content, ValidationContext context)

Implements abstract com.sun.msv.datatype.xsd.XSDatatypeImpl._createValue.

converts a whitespace-processed lexical value into the corresponding value object
protected final boolean
public String
convertToLexicalValue(Object value, SerializationContext
Context information that will be possibly used for the conversion. Currently, this object is used only by QName, but may be extended in the future.
context
)

Implements com.sun.msv.datatype.xsd.XSDatatype.convertToLexicalValue.

converts value object back to the corresponding value in the lexical space.
public final int
countLength(Object value)

Implements com.sun.msv.datatype.xsd.Discrete.countLength.

count the number of item in value type.
public final String
displayName()

Implements com.sun.msv.datatype.xsd.XSDatatype.displayName.

gets the displayable name of this type.
public final XSDatatype
getBaseType()

Implements com.sun.msv.datatype.xsd.XSDatatype.getBaseType.

gets the base type of this type.
public int
getIdType()

Overrides com.sun.msv.datatype.xsd.XSDatatypeImpl.getIdType.

Implements org.relaxng.datatype.Datatype.getIdType.

A property for RELAX NG DTD compatibility datatypes.
public Class<T>
getJavaObjectType()

Implements com.sun.msv.datatype.DatabindableDatatype.getJavaObjectType.

gets the type of the objects that are created by the createJavaObject method.
public final int
getVariety()

Implements com.sun.msv.datatype.xsd.XSDatatype.getVariety.

Variety of the ListType is VARIETY_LIST.
public boolean
isContextDependent()

Overrides com.sun.msv.datatype.xsd.XSDatatypeImpl.isContextDependent.

Implements org.relaxng.datatype.Datatype.isContextDependent.

The list type is context-dependent if its item type is so.
public final int
isFacetApplicable(String facetName)

Implements com.sun.msv.datatype.xsd.XSDatatype.isFacetApplicable.

returns if the specified facet is applicable to this datatype.
public final boolean
isFinal(int
one of pre-defined values (DERIVATION_BY_XXX).
derivationType
)

Overrides com.sun.msv.datatype.xsd.ConcreteType.isFinal.

Implements com.sun.msv.datatype.xsd.XSDatatype.isFinal.

checks if this type is declared as final for the specified kind of derivation.
Inherited from com.sun.msv.datatype.xsd.ConcreteType:
_createJavaObjectgetConcreteTypeserializeJavaObject

Field Detail

itemTypeback to summary
public final XSDatatypeImpl itemType

atomic base type

serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.sun.msv.datatype.xsd.ConcreteType.serialVersionUID.

Constructor Detail

ListTypeback to summary
public ListType(String nsUri, String newTypeName, XSDatatypeImpl itemType) throws DatatypeException

derives a new datatype from atomic datatype by list

Method Detail

_checkValidback to summary
protected void _checkValid(String content, ValidationContext context) throws DatatypeException

Overrides com.sun.msv.datatype.xsd.ConcreteType._checkValid.

The current implementation detects which list item is considered wrong.

_createValueback to summary
public Object _createValue(String content, ValidationContext context)

Implements abstract com.sun.msv.datatype.xsd.XSDatatypeImpl._createValue.

Doc from com.sun.msv.datatype.xsd.XSDatatypeImpl._createValue.

converts a whitespace-processed lexical value into the corresponding value object

checkFormatback to summary
protected final boolean checkFormat(String content, ValidationContext context)

Implements abstract com.sun.msv.datatype.xsd.XSDatatypeImpl.checkFormat.

convertToLexicalValueback to summary
public String convertToLexicalValue(Object value, SerializationContext context)

Implements com.sun.msv.datatype.xsd.XSDatatype.convertToLexicalValue.

Doc from com.sun.msv.datatype.xsd.XSDatatype.convertToLexicalValue.

converts value object back to the corresponding value in the lexical space.

This method does the reverse operation of the createValue method. The returned string is not necessarily the canonical representation. Also note that the implementation may accept invalid values without throwing IllegalArgumentException. To make sure that the result is actually a valid representation, call the isValid method.

Be careful not to confuse this method with The serializeJavaObject method, which is defined in the DatabindableDatatype method.

Parameters
context:SerializationContext

Context information that will be possibly used for the conversion. Currently, this object is used only by QName, but may be extended in the future.

countLengthback to summary
public final int countLength(Object value)

Implements com.sun.msv.datatype.xsd.Discrete.countLength.

Doc from com.sun.msv.datatype.xsd.Discrete.countLength.

count the number of item in value type. Actual semantics of this method varies.

displayNameback to summary
public final String displayName()

Implements com.sun.msv.datatype.xsd.XSDatatype.displayName.

Doc from com.sun.msv.datatype.xsd.XSDatatype.displayName.

gets the displayable name of this type. This method always return something. It is useful to provide a message to the user.

This method is an ad-hoc method and there is no corresponding property in the spec.

getBaseTypeback to summary
public final XSDatatype getBaseType()

Implements com.sun.msv.datatype.xsd.XSDatatype.getBaseType.

Doc from com.sun.msv.datatype.xsd.XSDatatype.getBaseType.

gets the base type of this type. This method returns null if this object represents the simple ur-type.

This method is intended to capture the semantics of the base type definition property of the simple type component, but there is an important difference.

Specifically, if you derive a type D from another type B, then calling D.getBaseType() does not necessarily return B. Instead, it may return an intermediate object (that represents a facet). Calling the getBaseType method recursively will eventually return B.

getIdTypeback to summary
public int getIdType()

Overrides com.sun.msv.datatype.xsd.XSDatatypeImpl.getIdType.

Implements org.relaxng.datatype.Datatype.getIdType.

Doc from com.sun.msv.datatype.xsd.XSDatatypeImpl.getIdType.

A property for RELAX NG DTD compatibility datatypes. ID_TYPE_NULL is returned by default.

Returns:int

Doc from org.relaxng.datatype.Datatype.getIdType.

If this datatype doesn't have any ID/IDREF semantics, it returns ID_TYPE_NULL. If it has such a semantics (for example, XSD:ID, XSD:IDREF and comp:ID type), then it returns ID_TYPE_ID, ID_TYPE_IDREF or ID_TYPE_IDREFS.

getJavaObjectTypeback to summary
public Class<T> getJavaObjectType()

Implements com.sun.msv.datatype.DatabindableDatatype.getJavaObjectType.

Doc from com.sun.msv.datatype.DatabindableDatatype.getJavaObjectType.

gets the type of the objects that are created by the createJavaObject method.

getVarietyback to summary
public final int getVariety()

Implements com.sun.msv.datatype.xsd.XSDatatype.getVariety.

Variety of the ListType is VARIETY_LIST. So this method always returns VARIETY_LIST.

Returns:int

Doc from com.sun.msv.datatype.xsd.XSDatatype.getVariety.

VARIETY_ATOMIC, VARIETY_LIST, or VARIETY_UNION.

isContextDependentback to summary
public boolean isContextDependent()

Overrides com.sun.msv.datatype.xsd.XSDatatypeImpl.isContextDependent.

Implements org.relaxng.datatype.Datatype.isContextDependent.

The list type is context-dependent if its item type is so.

Returns:boolean

Doc from org.relaxng.datatype.Datatype.isContextDependent.

true if this datatype is context-dependent (it needs a context object sometimes); false if this datatype is context-independent (it never needs a context object).

isFacetApplicableback to summary
public final int isFacetApplicable(String facetName)

Implements com.sun.msv.datatype.xsd.XSDatatype.isFacetApplicable.

Doc from com.sun.msv.datatype.xsd.XSDatatype.isFacetApplicable.

returns if the specified facet is applicable to this datatype.

Returns:int

APPLICABLE
if the facet is applicable
FIXED
if the facet is already fixed (that is,not applicable)
NOT_ALLOWED
if the facet is not applicable to this datatype at all. this value is also returned for unknown facets.
isFinalback to summary
public final boolean isFinal(int derivationType)

Overrides com.sun.msv.datatype.xsd.ConcreteType.isFinal.

Implements com.sun.msv.datatype.xsd.XSDatatype.isFinal.

Doc from com.sun.msv.datatype.xsd.XSDatatype.isFinal.

checks if this type is declared as final for the specified kind of derivation.

In the terminology of the spec, this method can be used to examine the final property of this component.

Parameters
derivationType:int

one of pre-defined values (DERIVATION_BY_XXX).