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

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

All Implemented Interfaces:

Serializable

public class PartPackage
extends Object
implements Serializable

Class PartPackage.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

PartPackage()

Method Summary

void	addPart(int index, Part vPart)
void	addPart(Part vPart)
Enumeration<? extends Part>	enumeratePart() Method enumeratePart.
String	getName() Returns the value of field 'name'.
Part[]	getPart() Method getPart.Returns the contents of the collection in an Array.
Part	getPart(int index) Method getPart.
int	getPartCount() Method getPartCount.
boolean	isValid() Method isValid.
Iterator<? extends Part>	iteratePart() Method iteratePart.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllPart()
boolean	removePart(Part vPart) Method removePart.
Part	removePartAt(int index) Method removePartAt.
void	setName(String name) Sets the value of field 'name'.
void	setPart(int index, Part vPart)
void	setPart(Part[] vPartArray)
static PartPackage	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

PartPackage

public PartPackage()

Method Detail

addPart

public void addPart(Part vPart)
             throws IndexOutOfBoundsException

Parameters:

vPart -

Throws:

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

addPart

public void addPart(int index,
                    Part vPart)
             throws IndexOutOfBoundsException

Parameters:

index -

vPart -

Throws:

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

enumeratePart

public Enumeration<? extends Part> enumeratePart()

Method enumeratePart.

Returns:

an Enumeration over all possible elements of this collection

getName

public String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

getPart

public Part getPart(int index)
             throws IndexOutOfBoundsException

Method getPart.

Parameters:

index -

Returns:

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

Throws:

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

getPart

public Part[] getPart()

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

getPartCount

public int getPartCount()

Method getPartCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iteratePart

public Iterator<? extends Part> iteratePart()

Method iteratePart.

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

removeAllPart

public void removeAllPart()

removePart

public boolean removePart(Part vPart)

Method removePart.

Parameters:

vPart -

Returns:

true if the object was removed from the collection.

removePartAt

public Part removePartAt(int index)

Method removePartAt.

Parameters:

index -

Returns:

the element removed from the collection

setName

public void setName(String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setPart

public void setPart(int index,
                    Part vPart)
             throws IndexOutOfBoundsException

Parameters:

index -

vPart -

Throws:

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

setPart

public void setPart(Part[] vPartArray)

Parameters:

vPartArray -

unmarshal

public static PartPackage 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.PartPackage

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