Class ListClassDescriptor

java.lang.Object
org.exolab.castor.xml.descriptors.BaseDescriptor
org.exolab.castor.xml.descriptors.ListClassDescriptor
All Implemented Interfaces:
NatureExtendable, PropertyHolder, ClassDescriptor, XMLClassDescriptor

public class ListClassDescriptor extends BaseDescriptor
The default java.util.List class descriptor.
Version:
$Revision: 8690 $ $Date: 2004-12-16 22:49:25 -0700 (Thu, 16 Dec 2004) $
Author:
Keith Visco
  • Constructor Details

    • ListClassDescriptor

      public ListClassDescriptor()
      No-arg constructor.
    • ListClassDescriptor

      public ListClassDescriptor(String xmlName)
      Constructs a List Class Descriptor with the given XML name.
      Parameters:
      xmlName - XML schema item name of the element we describe.
  • Method Details

    • getAttributeDescriptors

      public XMLFieldDescriptor[] getAttributeDescriptors()
      Returns the set of attribute XMLFieldDescriptors.
      Returns:
      an array of XMLFieldDescriptors for all members that should be marshaled as attributes
    • getJavaClass

      public Class<?> getJavaClass()
      Returns the Class that this ClassDescriptor describes.
      Returns:
      the Class that this ClassDescriptor describes
    • getElementDescriptors

      public XMLFieldDescriptor[] getElementDescriptors()
      Returns the set of element MarshalDescriptors.
      Returns:
      an array of MarshalDescriptors for all members that should be marshaled as Elements
    • getExtends

      public ClassDescriptor getExtends()
      Returns the class descriptor of the class extended by this class.
      Returns:
      The extended class descriptor
    • getFields

      public FieldDescriptor[] getFields()
      Returns a list of fields represented by this descriptor.
      Returns:
      A list of fields
    • getContentDescriptor

      public XMLFieldDescriptor getContentDescriptor()
      Returns the descriptor for dealing with Text content.
      Returns:
      the XMLFieldDescriptor for dealing with Text content
    • 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 marshalling and unmarshalling as XML.
    • 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
    • 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.
    • setValidator

      public void setValidator(TypeValidator validator)
      Sets the type validator to use for this list.
      Parameters:
      validator - the type validator to use for this list.
    • setXMLName

      public void setXMLName(String xmlName)
      Sets the XML Name for the described object.
      Parameters:
      xmlName - the XML name to use for the described object.
    • setNameSpaceURI

      public void setNameSpaceURI(String nsURI)
      Sets the desired namespace URI for the described object.
      Parameters:
      nsURI - is the desired namespace URI
    • canAccept

      public boolean 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).
      Specified by:
      canAccept in interface XMLClassDescriptor
      Overrides:
      canAccept in class BaseDescriptor
      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.