Class FieldHandlerDef

java.lang.Object
org.exolab.castor.mapping.xml.FieldHandlerDef
All Implemented Interfaces:
Serializable

public class FieldHandlerDef extends Object implements Serializable
Version:
$Revision$ $Date$
See Also:
  • Constructor Details

    • FieldHandlerDef

      public FieldHandlerDef()
  • Method Details

    • addParam

      public void addParam(Param vParam) throws IndexOutOfBoundsException
      Parameters:
      vParam -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • addParam

      public void addParam(int index, Param vParam) throws IndexOutOfBoundsException
      Parameters:
      index -
      vParam -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • enumerateParam

      public Enumeration<? extends Param> enumerateParam()
      Method enumerateParam.
      Returns:
      an Enumeration over all possible elements of this collection
    • getClazz

      public String getClazz()
      Returns the value of field 'clazz'.
      Returns:
      the value of field 'Clazz'.
    • getName

      public String getName()
      Returns the value of field 'name'.
      Returns:
      the value of field 'Name'.
    • getParam

      public Param getParam(int index) throws IndexOutOfBoundsException
      Method getParam.
      Parameters:
      index -
      Returns:
      the value of the org.exolab.castor.mapping.xml.Param at the given index
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • getParam

      public Param[] getParam()
      Method getParam.Returns the contents of the collection in an Array.

      Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

      Returns:
      this collection as an Array
    • getParamCount

      public int getParamCount()
      Method getParamCount.
      Returns:
      the size of this collection
    • isValid

      public boolean isValid()
      Method isValid.
      Returns:
      true if this object is valid according to the schema
    • iterateParam

      public Iterator<? extends Param> iterateParam()
      Method iterateParam.
      Returns:
      an Iterator over all possible elements in this collection
    • marshal

      public void marshal(Writer out) throws MarshalException, ValidationException
      Parameters:
      out -
      Throws:
      MarshalException - if object is null or if any SAXException is thrown during marshaling
      ValidationException - if this object is an invalid instance according to the schema
    • marshal

      public void marshal(ContentHandler handler) throws IOException, MarshalException, ValidationException
      Parameters:
      handler -
      Throws:
      IOException - if an IOException occurs during marshaling
      ValidationException - if this object is an invalid instance according to the schema
      MarshalException - if object is null or if any SAXException is thrown during marshaling
    • removeAllParam

      public void removeAllParam()
    • removeParam

      public boolean removeParam(Param vParam)
      Method removeParam.
      Parameters:
      vParam -
      Returns:
      true if the object was removed from the collection.
    • removeParamAt

      public Param removeParamAt(int index)
      Method removeParamAt.
      Parameters:
      index -
      Returns:
      the element removed from the collection
    • setClazz

      public void setClazz(String clazz)
      Sets the value of field 'clazz'.
      Parameters:
      clazz - the value of field 'clazz'.
    • setName

      public void setName(String name)
      Sets the value of field 'name'.
      Parameters:
      name - the value of field 'name'.
    • setParam

      public void setParam(int index, Param vParam) throws IndexOutOfBoundsException
      Parameters:
      index -
      vParam -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection
    • setParam

      public void setParam(Param[] vParamArray)
      Parameters:
      vParamArray -
    • unmarshal

      public static FieldHandlerDef unmarshal(Reader reader) throws MarshalException, ValidationException
      Method unmarshal.
      Parameters:
      reader -
      Returns:
      the unmarshaled org.exolab.castor.mapping.xml.FieldHandlerDef
      Throws:
      MarshalException - if object is null or if any SAXException is thrown during marshaling
      ValidationException - if this object is an invalid instance according to the schema
    • validate

      public void validate() throws ValidationException
      Throws:
      ValidationException - if this object is an invalid instance according to the schema