Class Forces
java.lang.Object
org.exolab.castor.builder.binding.xml.Forces
- All Implemented Interfaces:
Serializable
- Version:
- $Revision$ $Date$
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
Method enumerateForce.String[]
getForce()
Method getForce.Returns the contents of the collection in an Array.getForce
(int index) Method getForce.int
Method getForceCount.boolean
isValid()
Method isValid.Method iterateForce.void
void
marshal
(ContentHandler handler) void
boolean
removeForce
(String vForce) Method removeForce.removeForceAt
(int index) Method removeForceAt.void
void
static Forces
unmarshalForces
(Reader reader) Method unmarshalForces.void
validate()
-
Constructor Details
-
Forces
public Forces()
-
-
Method Details
-
addForce
- Parameters:
vForce
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
addForce
- Parameters:
index
-vForce
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
enumerateForce
Method enumerateForce.- Returns:
- an Enumeration over all possible elements of this collection
-
getForce
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
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
Method iterateForce.- Returns:
- an Iterator over all possible elements in this collection
-
marshal
- Parameters:
out
-- Throws:
MarshalException
- if object is null or if any SAXException is thrown during marshalingValidationException
- 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 marshalingValidationException
- if this object is an invalid instance according to the schemaMarshalException
- if object is null or if any SAXException is thrown during marshaling
-
removeAllForce
public void removeAllForce() -
removeForce
Method removeForce.- Parameters:
vForce
-- Returns:
- true if the object was removed from the collection.
-
removeForceAt
Method removeForceAt.- Parameters:
index
-- Returns:
- the element removed from the collection
-
setForce
- Parameters:
index
-vForce
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
setForce
- Parameters:
vForceArray
-
-
unmarshalForces
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 marshalingValidationException
- if this object is an invalid instance according to the schema
-
validate
- Throws:
ValidationException
- if this object is an invalid instance according to the schema
-