org.mars_sim.msp.config.model.partpackage
Class PartPackageList

java.lang.Object
  org.mars_sim.msp.config.model.partpackage.PartPackageList

All Implemented Interfaces:

Serializable

public class PartPackageList
extends Object
implements Serializable

Class PartPackageList.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

PartPackageList()

Method Summary

void	addPartPackage(int index, PartPackage vPartPackage)
void	addPartPackage(PartPackage vPartPackage)
Enumeration<? extends PartPackage>	enumeratePartPackage() Method enumeratePartPackage.
PartPackage[]	getPartPackage() Method getPartPackage.Returns the contents of the collection in an Array.
PartPackage	getPartPackage(int index) Method getPartPackage.
int	getPartPackageCount() Method getPartPackageCount.
boolean	isValid() Method isValid.
Iterator<? extends PartPackage>	iteratePartPackage() Method iteratePartPackage.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllPartPackage()
boolean	removePartPackage(PartPackage vPartPackage) Method removePartPackage.
PartPackage	removePartPackageAt(int index) Method removePartPackageAt.
void	setPartPackage(int index, PartPackage vPartPackage)
void	setPartPackage(PartPackage[] vPartPackageArray)
static PartPackageList	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PartPackageList

public PartPackageList()

Method Detail

addPartPackage

public void addPartPackage(PartPackage vPartPackage)
                    throws IndexOutOfBoundsException

Parameters:

vPartPackage -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addPartPackage

public void addPartPackage(int index,
                           PartPackage vPartPackage)
                    throws IndexOutOfBoundsException

Parameters:

index -

vPartPackage -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumeratePartPackage

public Enumeration<? extends PartPackage> enumeratePartPackage()

Method enumeratePartPackage.

Returns:

an Enumeration over all possible elements of this collection

getPartPackage

public PartPackage getPartPackage(int index)
                           throws IndexOutOfBoundsException

Method getPartPackage.

Parameters:

index -

Returns:

the value of the org.mars_sim.msp.config.model.partpackage.PartPackage at the given index

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getPartPackage

public PartPackage[] getPartPackage()

Method getPartPackage.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

getPartPackageCount

public int getPartPackageCount()

Method getPartPackageCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iteratePartPackage

public Iterator<? extends PartPackage> iteratePartPackage()

Method iteratePartPackage.

Returns:

an Iterator over all possible elements in this collection

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllPartPackage

public void removeAllPartPackage()

removePartPackage

public boolean removePartPackage(PartPackage vPartPackage)

Method removePartPackage.

Parameters:

vPartPackage -

Returns:

true if the object was removed from the collection.

removePartPackageAt

public PartPackage removePartPackageAt(int index)

Method removePartPackageAt.

Parameters:

index -

Returns:

the element removed from the collection

setPartPackage

public void setPartPackage(int index,
                           PartPackage vPartPackage)
                    throws IndexOutOfBoundsException

Parameters:

index -

vPartPackage -

Throws:

IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setPartPackage

public void setPartPackage(PartPackage[] vPartPackageArray)

Parameters:

vPartPackageArray -

unmarshal

public static PartPackageList unmarshal(Reader reader)
                                 throws org.exolab.castor.xml.MarshalException,
                                        org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.mars_sim.msp.config.model.partpackage.PartPackageList

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema