org.mars_sim.msp.config.model.settlement
Class InitialSettlementList

java.lang.Object
  org.mars_sim.msp.config.model.settlement.InitialSettlementList

All Implemented Interfaces:

Serializable

public class InitialSettlementList
extends Object
implements Serializable

Class InitialSettlementList.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

InitialSettlementList()

Method Summary

void	addSettlement(int index, Settlement vSettlement)
void	addSettlement(Settlement vSettlement)
Enumeration<? extends Settlement>	enumerateSettlement() Method enumerateSettlement.
Settlement[]	getSettlement() Method getSettlement.Returns the contents of the collection in an Array.
Settlement	getSettlement(int index) Method getSettlement.
int	getSettlementCount() Method getSettlementCount.
boolean	isValid() Method isValid.
Iterator<? extends Settlement>	iterateSettlement() Method iterateSettlement.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllSettlement()
boolean	removeSettlement(Settlement vSettlement) Method removeSettlement.
Settlement	removeSettlementAt(int index) Method removeSettlementAt.
void	setSettlement(int index, Settlement vSettlement)
void	setSettlement(Settlement[] vSettlementArray)
static InitialSettlementList	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

InitialSettlementList

public InitialSettlementList()

Method Detail

addSettlement

public void addSettlement(Settlement vSettlement)
                   throws IndexOutOfBoundsException

Parameters:

vSettlement -

Throws:

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

addSettlement

public void addSettlement(int index,
                          Settlement vSettlement)
                   throws IndexOutOfBoundsException

Parameters:

index -

vSettlement -

Throws:

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

enumerateSettlement

public Enumeration<? extends Settlement> enumerateSettlement()

Method enumerateSettlement.

Returns:

an Enumeration over all possible elements of this collection

getSettlement

public Settlement getSettlement(int index)
                         throws IndexOutOfBoundsException

Method getSettlement.

Parameters:

index -

Returns:

the value of the org.mars_sim.msp.config.model.settlement.Settlement at the given index

Throws:

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

getSettlement

public Settlement[] getSettlement()

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

getSettlementCount

public int getSettlementCount()

Method getSettlementCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateSettlement

public Iterator<? extends Settlement> iterateSettlement()

Method iterateSettlement.

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

removeAllSettlement

public void removeAllSettlement()

removeSettlement

public boolean removeSettlement(Settlement vSettlement)

Method removeSettlement.

Parameters:

vSettlement -

Returns:

true if the object was removed from the collection.

removeSettlementAt

public Settlement removeSettlementAt(int index)

Method removeSettlementAt.

Parameters:

index -

Returns:

the element removed from the collection

setSettlement

public void setSettlement(int index,
                          Settlement vSettlement)
                   throws IndexOutOfBoundsException

Parameters:

index -

vSettlement -

Throws:

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

setSettlement

public void setSettlement(Settlement[] vSettlementArray)

Parameters:

vSettlementArray -

unmarshal

public static InitialSettlementList 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.settlement.InitialSettlementLis

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