Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.exolab.castor.xml.descriptors.BaseDescriptor
org.exolab.castor.xml.descriptors.StringClassDescriptor
public class StringClassDescriptor
extends BaseDescriptor
Constructor Summary | |
|
Method Summary | |
AccessMode |
|
XMLFieldDescriptor[] |
|
XMLFieldDescriptor |
|
XMLFieldDescriptor[] |
|
ClassDescriptor |
|
XMLFieldDescriptor |
|
FieldDescriptor[] |
|
FieldDescriptor |
|
Class |
|
String | |
String | |
TypeValidator |
|
String |
|
void |
|
void |
|
void |
|
Methods inherited from class org.exolab.castor.xml.descriptors.BaseDescriptor | |
canAccept , checkDescriptorForCorrectOrderWithinSequence , isChoice |
public AccessMode getAccessMode()
Returns the access mode specified for this class.
- Returns:
- The access mode
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
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
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
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
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 againstnamespace
- the namespace urinodeType
- 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.
public FieldDescriptor[] getFields()
Returns a list of fields represented by this descriptor.
- Specified by:
- getFields in interface ClassDescriptor
- Returns:
- A list of fields
public FieldDescriptor getIdentity()
Returns the identity field, null if this class has no identity.
- Specified by:
- getIdentity in interface ClassDescriptor
- Returns:
- The identity field
public Class getJavaClass()
Returns the Class that this ClassDescriptor describes.
- Specified by:
- getJavaClass in interface ClassDescriptor
- Returns:
- the Class that this ClassDescriptor describes.
public String getNameSpacePrefix()
- Specified by:
- getNameSpacePrefix in interface XMLClassDescriptor
- Returns:
- the namespace prefix to use when marshaling as XML.
public String getNameSpaceURI()
- Specified by:
- getNameSpaceURI in interface XMLClassDescriptor
- Returns:
- the namespace URI used when marshaling and unmarshaling as XML.
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.
public String getXMLName()
Returns the XML Name for the Class being described.
- Specified by:
- getXMLName in interface XMLClassDescriptor
- Returns:
- the XML name.
public void setNameSpaceURI(String nsURI)
Sets the desired namespace URI for the described object.
- Parameters:
nsURI
- is the desired namespace URI
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.
public void setXMLName(String xmlName)
Sets the XML Name for the described object.
- Parameters:
xmlName
- the XML name to use for the described object.