Package org.exolab.castor.builder.binding.xml

Class Forces

java.lang.Object
org.exolab.castor.builder.binding.xml.Forces
All Implemented Interfaces:
Serializable
public class Forces extends Object implements Serializable
Class Forces.
Version:
$Revision$ $Date$
See Also:

  • Constructor Details

    • Forces

      public Forces()

  • Method Details

    • addForce

      public void addForce(String vForce) throws IndexOutOfBoundsException
      Parameters:
      vForce -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection

    • addForce

      public void addForce(int index, String vForce) throws IndexOutOfBoundsException
      Parameters:
      index -
      vForce -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection

    • enumerateForce

      public Enumeration enumerateForce()
      Method enumerateForce.
      Returns:
      an Enumeration over all possible elements of this collection

    • getForce

      public String getForce(int index) throws IndexOutOfBoundsException
      Method getForce.
      Parameters:
      index -
      Returns:
      the value of the java.lang.String at the given index
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection

    • getForce

      public String[] getForce()
      Method getForce.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

    • getForceCount

      public int getForceCount()
      Method getForceCount.
      Returns:
      the size of this collection

    • isValid

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

    • iterateForce

      public Iterator iterateForce()
      Method iterateForce.
      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

    • removeAllForce

      public void removeAllForce()

    • removeForce

      public boolean removeForce(String vForce)
      Method removeForce.
      Parameters:
      vForce -
      Returns:
      true if the object was removed from the collection.

    • removeForceAt

      public String removeForceAt(int index)
      Method removeForceAt.
      Parameters:
      index -
      Returns:
      the element removed from the collection

    • setForce

      public void setForce(int index, String vForce) throws IndexOutOfBoundsException
      Parameters:
      index -
      vForce -
      Throws:
      IndexOutOfBoundsException - if the index given is outside the bounds of the collection

    • setForce

      public void setForce(String[] vForceArray)
      Parameters:
      vForceArray -

    • unmarshalForces

      public static Forces unmarshalForces(Reader reader) throws MarshalException, ValidationException
      Method unmarshalForces.
      Parameters:
      reader -
      Returns:
      the unmarshaled org.exolab.castor.builder.binding.xml.Forces
      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