org.apache.axis.description

Class TypeDesc

public class TypeDesc extends Object implements Serializable

A TypeDesc represents a Java<->XML data binding. It is essentially a collection of FieldDescs describing how to map each field in a Java class to XML.

Author: Glen Daniels (gdaniels@apache.org)

Field Summary
static Class[]	noClasses
static Object[]	noObjects

Constructor Summary
	TypeDesc(Class javaClass) Creates a new `TypeDesc` instance.
	TypeDesc(Class javaClass, boolean canSearchParents) Creates a new `TypeDesc` instance.

Method Summary
void	addFieldDesc(FieldDesc field) Add a new FieldDesc, keeping the convenience fields in sync.
BeanPropertyDescriptor	getAnyContentDescriptor()
BeanPropertyDescriptor	getAnyDesc()
QName	getAttributeNameForField(String fieldName) Get the QName associated with this field, but only if it's marked as an attribute.
QName	getElementNameForField(String fieldName) Get the QName associated with this field, but only if it's marked as an element.
FieldDesc	getFieldByName(String name) Get a FieldDesc by field name.
String	getFieldNameForAttribute(QName qname) Get the field name associated with this QName, but only if it's marked as an attribute.
String	getFieldNameForElement(QName qname, boolean ignoreNS) Get the field name associated with this QName, but only if it's marked as an element.
FieldDesc[]	getFields() Obtain the current array of FieldDescs
FieldDesc[]	getFields(boolean searchParents)
Map	getPropertyDescriptorMap() Get/Cache the property descriptor map
BeanPropertyDescriptor[]	getPropertyDescriptors() Get/Cache the property descriptors
static TypeDesc	getTypeDescForClass(Class cls) Static function for centralizing access to type metadata for a given class.
QName	getXmlType()
boolean	hasAttributes() Do we have any FieldDescs marked as attributes?
static void	registerTypeDescForClass(Class cls, TypeDesc td) Static function to explicitly register a type description for a given class.
void	setFields(FieldDesc[] newFields) Replace the array of FieldDescs, making sure we keep our convenience caches in sync.
void	setXmlType(QName xmlType)

Field Detail

Constructor Detail

TypeDesc

public TypeDesc(Class javaClass)

Creates a new TypeDesc instance. The type desc can search the metadata of its type'sparent classes.

Parameters: javaClass a Class value

TypeDesc

public TypeDesc(Class javaClass, boolean canSearchParents)

Creates a new TypeDesc instance.

Parameters: javaClass a Class value canSearchParents whether the type desc can search the metadata of its type's parent classes.

Method Detail

addFieldDesc

public void addFieldDesc(FieldDesc field)

Add a new FieldDesc, keeping the convenience fields in sync.

getAnyContentDescriptor

public BeanPropertyDescriptor getAnyContentDescriptor()

getAnyDesc

public BeanPropertyDescriptor getAnyDesc()

getAttributeNameForField

public QName getAttributeNameForField(String fieldName)

Get the QName associated with this field, but only if it's marked as an attribute.

getElementNameForField

public QName getElementNameForField(String fieldName)

Get the QName associated with this field, but only if it's marked as an element.

getFieldByName

public FieldDesc getFieldByName(String name)

Get a FieldDesc by field name.

getFieldNameForAttribute

public String getFieldNameForAttribute(QName qname)

Get the field name associated with this QName, but only if it's marked as an attribute.

getFieldNameForElement

public String getFieldNameForElement(QName qname, boolean ignoreNS)

Get the field name associated with this QName, but only if it's marked as an element. If the "ignoreNS" argument is true, just compare localNames.

getFields

public FieldDesc[] getFields()

Obtain the current array of FieldDescs

getFields

public FieldDesc[] getFields(boolean searchParents)

getPropertyDescriptorMap

public Map getPropertyDescriptorMap()

Get/Cache the property descriptor map

Returns: Map with key=propertyName, value=descriptor

getPropertyDescriptors

public BeanPropertyDescriptor[] getPropertyDescriptors()

Get/Cache the property descriptors

Returns: PropertyDescriptor

getTypeDescForClass

public static TypeDesc getTypeDescForClass(Class cls)

Static function for centralizing access to type metadata for a given class. This checks for a static getTypeDesc() method on the class or _Helper class. Eventually we may extend this to provide for external metadata config (via files sitting in the classpath, etc).

Parameters: cls the Class we're registering metadata about td the TypeDesc containing the metadata

setFields

public void setFields(FieldDesc[] newFields)

Replace the array of FieldDescs, making sure we keep our convenience caches in sync.

setXmlType

public void setXmlType(QName xmlType)