org.exolab.castor.builder.binding.xml
Class Forces

java.lang.Object
  extended by org.exolab.castor.builder.binding.xml.Forces
All Implemented Interfaces:
java.io.Serializable

public class Forces
extends java.lang.Object
implements java.io.Serializable

Class Forces.

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
Forces()
           
 
Method Summary
 void addForce(int index, java.lang.String vForce)
           
 void addForce(java.lang.String vForce)
           
 java.util.Enumeration enumerateForce()
          Method enumerateForce.
 java.lang.String[] getForce()
          Method getForce.Returns the contents of the collection in an Array.
 java.lang.String getForce(int index)
          Method getForce.
 int getForceCount()
          Method getForceCount.
 boolean isValid()
          Method isValid.
 java.util.Iterator iterateForce()
          Method iterateForce.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllForce()
           
 boolean removeForce(java.lang.String vForce)
          Method removeForce.
 java.lang.String removeForceAt(int index)
          Method removeForceAt.
 void setForce(int index, java.lang.String vForce)
           
 void setForce(java.lang.String[] vForceArray)
           
static Forces unmarshalForces(java.io.Reader reader)
          Method unmarshalForces.
 void validate()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Forces

public Forces()
Method Detail

addForce

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

addForce

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

enumerateForce

public java.util.Enumeration enumerateForce()
Method enumerateForce.

Returns:
an Enumeration over all possible elements of this collection

getForce

public java.lang.String getForce(int index)
                          throws java.lang.IndexOutOfBoundsException
Method getForce.

Parameters:
index -
Returns:
the value of the java.lang.String at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getForce

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

Returns:
an Iterator over all possible elements in this collection

marshal

public void marshal(java.io.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(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    MarshalException,
                    ValidationException
Parameters:
handler -
Throws:
java.io.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(java.lang.String vForce)
Method removeForce.

Parameters:
vForce -
Returns:
true if the object was removed from the collection.

removeForceAt

public java.lang.String removeForceAt(int index)
Method removeForceAt.

Parameters:
index -
Returns:
the element removed from the collection

setForce

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

setForce

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

unmarshalForces

public static Forces unmarshalForces(java.io.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


Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com