|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exolab.castor.xml.descriptors.StringClassDescriptor
public class StringClassDescriptor
The default String class descriptor.
Constructor Summary | |
---|---|
StringClassDescriptor()
No-arg constructor. |
Method Summary | |
---|---|
boolean |
canAccept(java.lang.String name,
java.lang.String namespace,
java.lang.Object object)
Returns true if the given object represented by this XMLClassDescriptor can accept a member whose name is given. |
void |
checkDescriptorForCorrectOrderWithinSequence(XMLFieldDescriptor elementDescriptor,
UnmarshalState parentState,
java.lang.String xmlName)
Checks whether the given XMLFieldDescriptor is the one actually expected, given the natural order as defined by a sequence definition |
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(java.lang.String name,
java.lang.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. |
java.lang.Class |
getJavaClass()
Returns the Class that this ClassDescriptor describes. |
java.lang.String |
getNameSpacePrefix()
Returns the namespace prefix to use when marshalling as XML. |
java.lang.String |
getNameSpaceURI()
Returns the namespace URI used when marshalling and unmarshalling as XML. |
TypeValidator |
getValidator()
Returns a specific validator for the class described by this ClassDescriptor. |
java.lang.String |
getXMLName()
Returns the XML Name for the Class being described. |
void |
setNameSpaceURI(java.lang.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(java.lang.String xmlName)
Sets the XML Name for the described object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StringClassDescriptor()
Method Detail |
---|
public XMLFieldDescriptor[] getAttributeDescriptors()
getAttributeDescriptors
in interface XMLClassDescriptor
public java.lang.Class getJavaClass()
getJavaClass
in interface ClassDescriptor
public XMLFieldDescriptor[] getElementDescriptors()
getElementDescriptors
in interface XMLClassDescriptor
public ClassDescriptor getExtends()
getExtends
in interface ClassDescriptor
public FieldDescriptor[] getFields()
getFields
in interface ClassDescriptor
public XMLFieldDescriptor getContentDescriptor()
getContentDescriptor
in interface XMLClassDescriptor
public XMLFieldDescriptor getFieldDescriptor(java.lang.String name, java.lang.String namespace, NodeType nodeType)
getFieldDescriptor
in interface XMLClassDescriptor
name
- the xml name to match againstnamespace
- the namespace urinodeType
- the NodeType to match against, or null if the node type
is not known.
public java.lang.String getNameSpacePrefix()
XMLClassDescriptor
getNameSpacePrefix
in interface XMLClassDescriptor
public java.lang.String getNameSpaceURI()
XMLClassDescriptor
getNameSpaceURI
in interface XMLClassDescriptor
public FieldDescriptor getIdentity()
getIdentity
in interface ClassDescriptor
public AccessMode getAccessMode()
public TypeValidator getValidator()
getValidator
in interface XMLClassDescriptor
public java.lang.String getXMLName()
getXMLName
in interface XMLClassDescriptor
public void setValidator(StringValidator validator)
validator
- the type validator to use.public void setXMLName(java.lang.String xmlName)
xmlName
- the XML name to use for the described object.public void setNameSpaceURI(java.lang.String nsURI)
nsURI
- is the desired namespace URIpublic boolean canAccept(java.lang.String name, java.lang.String namespace, java.lang.Object object)
This is mainly used for container objects (that can contain other objects), in this particular case the implementation returns false.
canAccept
in interface XMLClassDescriptor
name
- the xml name of the field to checknamespace
- the namespace uriobject
- the object represented by this XMLCLassDescriptor
public void checkDescriptorForCorrectOrderWithinSequence(XMLFieldDescriptor elementDescriptor, UnmarshalState parentState, java.lang.String xmlName) throws ValidationException
checkDescriptorForCorrectOrderWithinSequence
in interface XMLClassDescriptor
elementDescriptor
- The XML field descriptor to be checkedxmlName
- TODO
ValidationException
- If the descriptor is not the one expectedcheckDescriptorForCorrectOrderWithinSequence(org.exolab.castor.xml.XMLFieldDescriptor,
org.exolab.castor.xml.UnmarshalState, java.lang.String)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |