Inheritance diagram for org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor:

Public Member Functions
XMLClassDescriptor	getClassDescriptor ()
XMLFieldDescriptor[]	getAttributeDescriptors ()
XMLFieldDescriptor	getContentDescriptor ()
XMLFieldDescriptor	getFieldDescriptor (String name, String namespace, NodeType nodeType)
XMLFieldDescriptor[]	getElementDescriptors ()
String	getNameSpacePrefix ()
String	getNameSpaceURI ()
TypeValidator	getValidator ()
String	getXMLName ()
boolean	introspected ()
boolean	canAccept (String name, String namespace, Object object)
Class	getJavaClass ()
FieldDescriptor[]	getFields ()
ClassDescriptor	getExtends ()
FieldDescriptor	getIdentity ()
AccessMode	getAccessMode ()
Protected Member Functions
	InternalXMLClassDescriptor (XMLClassDescriptor classDesc)

Detailed Description

An internal implementation of XMLClassDescriptor used by the Unmarshaller and Marshaller...

Constructor & Destructor Documentation

org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.InternalXMLClassDescriptor ( XMLClassDescriptor classDesc ) [protected]

Creates a new InternalXMLClassDescriptor for the given XMLClassDescriptor

Member Function Documentation

boolean org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.canAccept	(	String	name,
		String	namespace,
		Object	object
	)

Returns true if the given object, represented by this XMLClassDescriptor, can accept a value for the member associated with the given xml name and namespace.

An XMLClassDescriptor can accept a value for a field if it contains a descriptor that matches the given xml name and namespace and if the given object can hold this field (i.e a value is not already set for this field).

Parameters:

	name	the xml name of the field to check
	namespace	the namespace uri
	object	the object instance represented by this XMLCLassDescriptor

Returns:: true if the given object represented by this XMLClassDescriptor can accept a member whose name is given.

Implements org.exolab.castor.xml.XMLClassDescriptor.

References org.exolab.castor.xml.XMLClassDescriptor.canAccept().

AccessMode org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getAccessMode ( )

Returns the access mode specified for this class.

Returns:: The access mode

Implements org.exolab.castor.mapping.ClassDescriptor.

References org.exolab.castor.mapping.ClassDescriptor.getAccessMode().

XMLFieldDescriptor [] org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.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.

Implements org.exolab.castor.xml.XMLClassDescriptor.

References org.exolab.castor.xml.XMLClassDescriptor.getAttributeDescriptors().

XMLClassDescriptor org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getClassDescriptor ( )

Returns the XMLClassDescriptor that this InternalXMLClassDescriptor wraps.

Returns:: the XMLClassDescriptor

XMLFieldDescriptor org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.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.

Implements org.exolab.castor.xml.XMLClassDescriptor.

References org.exolab.castor.xml.XMLClassDescriptor.getContentDescriptor().

XMLFieldDescriptor [] org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.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.

Implements org.exolab.castor.xml.XMLClassDescriptor.

References org.exolab.castor.xml.XMLClassDescriptor.getElementDescriptors().

ClassDescriptor org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getExtends ( )

Returns the class descriptor of the class extended by this class.

Returns:: The extended class descriptor

Implements org.exolab.castor.mapping.ClassDescriptor.

References org.exolab.castor.mapping.ClassDescriptor.getExtends().

XMLFieldDescriptor org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.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.

Implements org.exolab.castor.xml.XMLClassDescriptor.

References org.exolab.castor.xml.XMLClassDescriptor.getFieldDescriptor().

FieldDescriptor [] org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getFields ( )

Returns a list of fields represented by this descriptor.

Returns:: A list of fields

Implements org.exolab.castor.mapping.ClassDescriptor.

References org.exolab.castor.mapping.ClassDescriptor.getFields().

FieldDescriptor org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getIdentity ( )

Returns the identity field, null if this class has no identity.

Returns:: The identity field

Implements org.exolab.castor.mapping.ClassDescriptor.

References org.exolab.castor.mapping.ClassDescriptor.getIdentity().

Class org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getJavaClass ( )

Returns the Java class represented by this descriptor.

Returns:: The Java class

Implements org.exolab.castor.mapping.ClassDescriptor.

References org.exolab.castor.mapping.ClassDescriptor.getJavaClass().

String org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getNameSpacePrefix ( )

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

Implements org.exolab.castor.xml.XMLClassDescriptor.

References org.exolab.castor.xml.XMLClassDescriptor.getNameSpacePrefix().

String org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getNameSpaceURI ( )

Returns:: the namespace URI used when marshalling and unmarshalling as XML.

Implements org.exolab.castor.xml.XMLClassDescriptor.

References org.exolab.castor.xml.XMLClassDescriptor.getNameSpaceURI().

TypeValidator org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.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.

Implements org.exolab.castor.xml.XMLClassDescriptor.

References org.exolab.castor.xml.XMLClassDescriptor.getValidator().

String org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.getXMLName ( )

Returns the XML Name for the Class being described.

Returns:: the XML name.

Implements org.exolab.castor.xml.XMLClassDescriptor.

References org.exolab.castor.xml.XMLClassDescriptor.getXMLName().

boolean org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor.introspected ( )

Returns true if the wrapped ClassDescriptor was created by introspection.

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

The documentation for this class was generated from the following file:

MarshalFramework.java

All Classes Namespaces Files Functions Variables Enumerations Properties

org.exolab.castor.xml.MarshalFramework.InternalXMLClassDescriptor Class Reference

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation