Inheritance diagram for org.exolab.castor.xml.descriptors.ListClassDescriptor:

Classes
class	IteratorEnumerator
Public Member Functions
	ListClassDescriptor ()
	ListClassDescriptor (String xmlName)
XMLFieldDescriptor[]	getAttributeDescriptors ()
Class	getJavaClass ()
XMLFieldDescriptor[]	getElementDescriptors ()
ClassDescriptor	getExtends ()
FieldDescriptor[]	getFields ()
XMLFieldDescriptor	getContentDescriptor ()
XMLFieldDescriptor	getFieldDescriptor (String name, String namespace, NodeType nodeType)
String	getNameSpacePrefix ()
String	getNameSpaceURI ()
FieldDescriptor	getIdentity ()
AccessMode	getAccessMode ()
TypeValidator	getValidator ()
String	getXMLName ()
void	setValidator (TypeValidator validator)
void	setXMLName (String xmlName)
void	setNameSpaceURI (String nsURI)
boolean	canAccept (String name, String namespace, Object object)

Detailed Description

The default java.util.List class descriptor

Author:: Keith Visco

Version:

Revision:: 1.2

Date:: 2004/12/17 05:46:13

Constructor & Destructor Documentation

org.exolab.castor.xml.descriptors.ListClassDescriptor.ListClassDescriptor ( )

org.exolab.castor.xml.descriptors.ListClassDescriptor.ListClassDescriptor ( String xmlName )

References org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setHandler(), org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setMatches(), and org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setMultivalued().

Member Function Documentation

boolean org.exolab.castor.xml.descriptors.ListClassDescriptor.canAccept	(	String	name,
		String	namespace,
		Object	object
	)

Returns true if the given object represented by this XMLClassDescriptor can accept a member whose name is given. An XMLClassDescriptor can accept a field if it contains a descriptor that matches the given name 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 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.

AccessMode org.exolab.castor.xml.descriptors.ListClassDescriptor.getAccessMode ( )

Returns the access mode specified for this class.

Returns:: The access mode

Implements org.exolab.castor.mapping.ClassDescriptor.

XMLFieldDescriptor [] org.exolab.castor.xml.descriptors.ListClassDescriptor.getAttributeDescriptors ( )

Returns the set of attribute XMLFieldDescriptors

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

Implements org.exolab.castor.xml.XMLClassDescriptor.

XMLFieldDescriptor org.exolab.castor.xml.descriptors.ListClassDescriptor.getContentDescriptor ( )

Returns the descriptor for dealing with Text content

Returns:: the XMLFieldDescriptor for dealing with Text content

Implements org.exolab.castor.xml.XMLClassDescriptor.

XMLFieldDescriptor [] org.exolab.castor.xml.descriptors.ListClassDescriptor.getElementDescriptors ( )

Returns the set of element MarshalDescriptors

Returns:: an array of MarshalDescriptors for all members that should be marshalled as Elements

Implements org.exolab.castor.xml.XMLClassDescriptor.

ClassDescriptor org.exolab.castor.xml.descriptors.ListClassDescriptor.getExtends ( )

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

Returns:: The extended class descriptor

Implements org.exolab.castor.mapping.ClassDescriptor.

XMLFieldDescriptor org.exolab.castor.xml.descriptors.ListClassDescriptor.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
	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.

Implements org.exolab.castor.xml.XMLClassDescriptor.

References org.exolab.castor.xml.NodeType.Element, and org.exolab.castor.xml.XMLFieldDescriptor.matches().

FieldDescriptor [] org.exolab.castor.xml.descriptors.ListClassDescriptor.getFields ( )

Returns a list of fields represented by this descriptor.

Returns:: A list of fields

Implements org.exolab.castor.mapping.ClassDescriptor.

FieldDescriptor org.exolab.castor.xml.descriptors.ListClassDescriptor.getIdentity ( )

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

Returns:: The identity field

Implements org.exolab.castor.mapping.ClassDescriptor.

Class org.exolab.castor.xml.descriptors.ListClassDescriptor.getJavaClass ( )

Returns the Class that this ClassDescriptor describes

Returns:: the Class that this ClassDescriptor describes

Implements org.exolab.castor.mapping.ClassDescriptor.

String org.exolab.castor.xml.descriptors.ListClassDescriptor.getNameSpacePrefix ( )

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

Implements org.exolab.castor.xml.XMLClassDescriptor.

String org.exolab.castor.xml.descriptors.ListClassDescriptor.getNameSpaceURI ( )

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

Implements org.exolab.castor.xml.XMLClassDescriptor.

TypeValidator org.exolab.castor.xml.descriptors.ListClassDescriptor.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.

String org.exolab.castor.xml.descriptors.ListClassDescriptor.getXMLName ( )

Returns the XML Name for the Class being described.

Returns:: the XML name.

Implements org.exolab.castor.xml.XMLClassDescriptor.

void org.exolab.castor.xml.descriptors.ListClassDescriptor.setNameSpaceURI ( String nsURI )

Sets the desired namespace URI for the described object

Parameters:

nsURI

is the desired namespace URI

void org.exolab.castor.xml.descriptors.ListClassDescriptor.setValidator ( TypeValidator validator )

void org.exolab.castor.xml.descriptors.ListClassDescriptor.setXMLName ( String xmlName )

Sets the XML Name for the described object.

Parameters:

xmlName

the XML name to use for the described object.

References org.exolab.castor.xml.util.XMLFieldDescriptorImpl.setXMLName().

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

ListClassDescriptor.java

All Classes Namespaces Files Functions Variables Enumerations Properties

org.exolab.castor.xml.descriptors.ListClassDescriptor Class Reference

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation