org.exolab.castor.xml.descriptors

Class LocaleDescriptor

java.lang.Object

org.exolab.castor.xml.descriptors.BaseDescriptor

org.exolab.castor.xml.descriptors.LocaleDescriptor

All Implemented Interfaces:

NatureExtendable, PropertyHolder, ClassDescriptor, XMLClassDescriptor

public class LocaleDescriptor
extends BaseDescriptor

A ClassDescriptor for java.util.Locale.

Version:

$Revision: 7296 $ $Date: 2004-12-16 22:45:54 -0700 (Thu, 16 Dec 2004) $

Author:

Keith Visco

Constructor Summary

Constructors

Constructor and Description
LocaleDescriptor() No-arg constructor.

Method Summary

Methods

Modifier and Type	Method and Description
AccessMode	getAccessMode() Returns the access mode specified for this class.
XMLFieldDescriptor[]	getAttributeDescriptors() Returns the set of XMLFieldDescriptors for all members that should be marshaled as XML attributes.
XMLFieldDescriptor	getContentDescriptor() Returns the XMLFieldDescriptor for the member that should be marshaled as text content.
XMLFieldDescriptor[]	getElementDescriptors() Returns the set of XMLFieldDescriptors for all members that should be marshaled as XML elements.
ClassDescriptor	getExtends() Returns the class descriptor of the class extended by this class.
XMLFieldDescriptor	getFieldDescriptor(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.
FieldDescriptor	getIdentity() Returns the identity field, null if this class has no identity.
Class	getJavaClass() Returns the Java class represented by this descriptor.
String	getNameSpacePrefix() Returns the namespace prefix to use when marshalling as XML.
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.
String	getXMLName() Returns the XML Name for the Class being described.
String	toString() Returns the String representation of this XMLClassDescriptor.

Methods inherited from class org.exolab.castor.xml.descriptors.BaseDescriptor

addNature, canAccept, checkDescriptorForCorrectOrderWithinSequence, getProperty, hasNature, isChoice, setProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LocaleDescriptor

public LocaleDescriptor()

No-arg constructor.

Method Detail

getAttributeDescriptors

public XMLFieldDescriptor[] getAttributeDescriptors()

Returns the set of XMLFieldDescriptors for all members that should be marshaled as XML attributes.

Returns:

an array of XMLFieldDescriptors for all members that should be marshaled as XML attributes.

getContentDescriptor

public XMLFieldDescriptor getContentDescriptor()

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

Returns:

the XMLFieldDescriptor for the member that should be marshaled as text content.

getElementDescriptors

public XMLFieldDescriptor[] getElementDescriptors()

Returns the set of XMLFieldDescriptors for all members that should be marshaled as XML elements.

Returns:

an array of XMLFieldDescriptors for all members that should be marshaled as XML elements.

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

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.

getNameSpacePrefix

public String getNameSpacePrefix()

Description copied from interface: XMLClassDescriptor

Returns the namespace prefix to use when marshalling as XML.

Returns:

the namespace prefix to use when marshaling as XML.

getNameSpaceURI

public String getNameSpaceURI()

Description copied from interface: XMLClassDescriptor

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

Returns:

the namespace URI used when marshaling and unmarshaling 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.

toString

public String toString()

Returns the String representation of this XMLClassDescriptor.

Overrides:

toString in class Object

Returns:

the String representation of this XMLClassDescriptor.

getJavaClass

public Class getJavaClass()

Returns the Java class represented by this descriptor.

Returns:

The Java class

getFields

public FieldDescriptor[] getFields()

Returns a list of fields represented by this descriptor.

Returns:

A list of fields

getExtends

public ClassDescriptor getExtends()

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

Returns:

The extended class descriptor

getIdentity

public FieldDescriptor getIdentity()

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

Returns:

The identity field

getAccessMode

public AccessMode getAccessMode()

Returns the access mode specified for this class.

Returns:

The access mode