org.exolab.castor.xml

Class MarshalFramework.InternalXMLClassDescriptor

class MarshalFramework.InternalXMLClassDescriptor extends Object implements XMLClassDescriptor

An internal implementation of XMLClassDescriptor used by the Unmarshaller and Marshaller...
Constructor Summary
protected InternalXMLClassDescriptor(XMLClassDescriptor classDesc)
Creates a new InternalXMLClassDescriptor for the given XMLClassDescriptor
Method Summary
booleancanAccept(String name, String namespace, Object object)
AccessModegetAccessMode()
Returns the access mode specified for this class.
XMLFieldDescriptor[]getAttributeDescriptors()
Returns the set of XMLFieldDescriptors for all members that should be marshalled as XML attributes.
XMLClassDescriptorgetClassDescriptor()
Returns the XMLClassDescriptor that this InternalXMLClassDescriptor wraps.
XMLFieldDescriptorgetContentDescriptor()
Returns the XMLFieldDescriptor for the member that should be marshalled as text content.
XMLFieldDescriptor[]getElementDescriptors()
Returns the set of XMLFieldDescriptors for all members that should be marshalled as XML elements.
ClassDescriptorgetExtends()
Returns the class descriptor of the class extended by this class.
XMLFieldDescriptorgetFieldDescriptor(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.
FieldDescriptorgetIdentity()
Returns the identity field, null if this class has no identity.
ClassgetJavaClass()
Returns the Java class represented by this descriptor.
StringgetNameSpacePrefix()
StringgetNameSpaceURI()
TypeValidatorgetValidator()
Returns a specific validator for the class described by this ClassDescriptor.
StringgetXMLName()
Returns the XML Name for the Class being described.
booleanintrospected()
Returns true if the wrapped ClassDescriptor was created by introspection.

Constructor Detail

InternalXMLClassDescriptor

protected InternalXMLClassDescriptor(XMLClassDescriptor classDesc)
Creates a new InternalXMLClassDescriptor for the given XMLClassDescriptor

Method Detail

canAccept

public boolean canAccept(String name, String namespace, Object object)

See Also: XMLClassDescriptor

getAccessMode

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

Returns: The access mode

getAttributeDescriptors

public XMLFieldDescriptor[] getAttributeDescriptors()
Returns the set of XMLFieldDescriptors for all members that should be marshalled as XML attributes. This includes namespace nodes.

Returns: an array of XMLFieldDescriptors for all members that should be marshalled as XML attributes.

getClassDescriptor

public XMLClassDescriptor getClassDescriptor()
Returns the XMLClassDescriptor that this InternalXMLClassDescriptor wraps.

Returns: the XMLClassDescriptor

getContentDescriptor

public XMLFieldDescriptor getContentDescriptor()
Returns the XMLFieldDescriptor for the member that should be marshalled as text content.

Returns: the XMLFieldDescriptor for the member that should be marshalled as text content.

getElementDescriptors

public XMLFieldDescriptor[] getElementDescriptors()
Returns the set of XMLFieldDescriptors for all members that should be marshalled as XML elements.

Returns: an array of XMLFieldDescriptors for all members that should be marshalled as XML elements.

getExtends

public ClassDescriptor getExtends()
Returns the class descriptor of the class extended by this class.

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.

Parameters: name the xml name to match against 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.

Returns: A list of fields

getIdentity

public FieldDescriptor getIdentity()
Returns the identity field, null if this class has no identity.

Returns: The identity field

getJavaClass

public Class getJavaClass()
Returns the Java class represented by this descriptor.

Returns: The Java class

getNameSpacePrefix

public String getNameSpacePrefix()

Returns: the namespace prefix to use when marshalling as XML.

getNameSpaceURI

public String getNameSpaceURI()

Returns: the namespace URI used when marshalling and unmarshalling 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.

Returns: the type validator for the class described by this ClassDescriptor.

getXMLName

public String getXMLName()
Returns the XML Name for the Class being described.

Returns: the XML name.

introspected

public boolean introspected()
Returns true if the wrapped ClassDescriptor was created by introspection.

Returns: true if the wrapped ClassDescriptor was created by introspection.

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