org.exolab.castor.xml.descriptors

Class StringClassDescriptor

Implemented Interfaces:
ClassDescriptor, XMLClassDescriptor
Known Direct Subclasses:
PrimitivesClassDescriptor

public class StringClassDescriptor
extends BaseDescriptor

The default String class descriptor.
Version:
$Revision: 7296 $ $Date: 2004-12-16 22:49:25 -0700 (Thu, 16 Dec 2004) $
Author:
Keith Visco

Constructor Summary

StringClassDescriptor()
No-arg constructor.

Method Summary

AccessMode
getAccessMode()
Returns the access mode specified for this class.
XMLFieldDescriptor[]
getAttributeDescriptors()
Returns the set of attribute XMLFieldDescriptors.
XMLFieldDescriptor
getContentDescriptor()
Returns the descriptor for dealing with Text content.
XMLFieldDescriptor[]
getElementDescriptors()
Returns the set of element MarshalDescriptors.
ClassDescriptor
getExtends()
Returns the class descriptor of the class extended by this class.
XMLFieldDescriptor
getFieldDescriptor(String name, String namespace, NodeType nodeType)
Returns the XML field descriptor matching the given xml name and nodeType.
FieldDescriptor[]
getFields()
Returns a list of fields represented by this descriptor.
FieldDescriptor
getIdentity()
Returns the identity field, null if this class has no identity.
Class
getJavaClass()
Returns the Class that this ClassDescriptor describes.
String
getNameSpacePrefix()
String
getNameSpaceURI()
TypeValidator
getValidator()
Returns a specific validator for the class described by this ClassDescriptor.
String
getXMLName()
Returns the XML Name for the Class being described.
void
setNameSpaceURI(String nsURI)
Sets the desired namespace URI for the described object.
void
setValidator(StringValidator validator)
Sets the type validator to use to validate an instance of this type.
void
setXMLName(String xmlName)
Sets the XML Name for the described object.

Methods inherited from class org.exolab.castor.xml.descriptors.BaseDescriptor

canAccept, checkDescriptorForCorrectOrderWithinSequence, isChoice

Constructor Details

StringClassDescriptor

public StringClassDescriptor()
No-arg constructor.

Method Details

getAccessMode

public AccessMode getAccessMode()
Returns the access mode specified for this class.
Returns:
The access mode

getAttributeDescriptors

public XMLFieldDescriptor[] getAttributeDescriptors()
Returns the set of attribute XMLFieldDescriptors.
Specified by:
getAttributeDescriptors in interface XMLClassDescriptor
Returns:
an array of XMLFieldDescriptors for all members that should be marshaled as attributes

getContentDescriptor

public XMLFieldDescriptor getContentDescriptor()
Returns the descriptor for dealing with Text content.
Specified by:
getContentDescriptor in interface XMLClassDescriptor
Returns:
the XMLFieldDescriptor for dealing with Text content

getElementDescriptors

public XMLFieldDescriptor[] getElementDescriptors()
Returns the set of element MarshalDescriptors.
Specified by:
getElementDescriptors in interface XMLClassDescriptor
Returns:
an array of MarshalDescriptors for all members that should be marshaled as Elements

getExtends

public ClassDescriptor getExtends()
Returns the class descriptor of the class extended by this class.
Specified by:
getExtends in interface ClassDescriptor
Returns:
The extended class descriptor

getFieldDescriptor

public XMLFieldDescriptor getFieldDescriptor(String name,
                                             String namespace,
                                             NodeType nodeType)
Returns the XML field descriptor matching the given xml name and nodeType. If NodeType is null, then either an AttributeDescriptor, or ElementDescriptor may be returned. Null is returned if no matching descriptor is available.
Specified by:
getFieldDescriptor in interface XMLClassDescriptor
Parameters:
name - the xml name to match against
namespace - the namespace uri
nodeType - the NodeType to match against, or null if the node type is not known.
Returns:
the matching descriptor, or null if no matching descriptor is available.

getFields

public FieldDescriptor[] getFields()
Returns a list of fields represented by this descriptor.
Specified by:
getFields in interface ClassDescriptor
Returns:
A list of fields

getIdentity

public FieldDescriptor getIdentity()
Returns the identity field, null if this class has no identity.
Specified by:
getIdentity in interface ClassDescriptor
Returns:
The identity field

getJavaClass

public Class getJavaClass()
Returns the Class that this ClassDescriptor describes.
Specified by:
getJavaClass in interface ClassDescriptor
Returns:
the Class that this ClassDescriptor describes.

getNameSpacePrefix

public String getNameSpacePrefix()
Specified by:
getNameSpacePrefix in interface XMLClassDescriptor
Returns:
the namespace prefix to use when marshaling as XML.

getNameSpaceURI

public String getNameSpaceURI()
Specified by:
getNameSpaceURI in interface XMLClassDescriptor
Returns:
the namespace URI used when marshaling and unmarshaling as XML.

getValidator

public TypeValidator getValidator()
Returns a specific validator for the class described by this ClassDescriptor. A null value may be returned if no specific validator exists.
Specified by:
getValidator in interface XMLClassDescriptor
Returns:
the type validator for the class described by this ClassDescriptor.

getXMLName

public String getXMLName()
Returns the XML Name for the Class being described.
Specified by:
getXMLName in interface XMLClassDescriptor
Returns:
the XML name.

setNameSpaceURI

public void setNameSpaceURI(String nsURI)
Sets the desired namespace URI for the described object.
Parameters:
nsURI - is the desired namespace URI

setValidator

public void setValidator(StringValidator validator)
Sets the type validator to use to validate an instance of this type.
Parameters:
validator - the type validator to use.

setXMLName

public void setXMLName(String xmlName)
Sets the XML Name for the described object.
Parameters:
xmlName - the XML name to use for the described object.

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