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

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

All Implemented Interfaces:

Serializable

public class SettlementNameList
extends Object
implements Serializable

Class SettlementNameList.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SettlementNameList()

Method Summary

void	addSettlementName(int index, SettlementName vSettlementName)
void	addSettlementName(SettlementName vSettlementName)
Enumeration<? extends SettlementName>	enumerateSettlementName() Method enumerateSettlementName.
SettlementName[]	getSettlementName() Method getSettlementName.Returns the contents of the collection in an Array.
SettlementName	getSettlementName(int index) Method getSettlementName.
int	getSettlementNameCount() Method getSettlementNameCount.
boolean	isValid() Method isValid.
Iterator<? extends SettlementName>	iterateSettlementName() Method iterateSettlementName.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllSettlementName()
boolean	removeSettlementName(SettlementName vSettlementName) Method removeSettlementName.
SettlementName	removeSettlementNameAt(int index) Method removeSettlementNameAt.
void	setSettlementName(int index, SettlementName vSettlementName)
void	setSettlementName(SettlementName[] vSettlementNameArray)
static SettlementNameList	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

SettlementNameList

public SettlementNameList()

Method Detail

addSettlementName

public void addSettlementName(SettlementName vSettlementName)
                       throws IndexOutOfBoundsException

Parameters:

vSettlementName -

Throws:

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

addSettlementName

public void addSettlementName(int index,
                              SettlementName vSettlementName)
                       throws IndexOutOfBoundsException

Parameters:

index -

vSettlementName -

Throws:

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

enumerateSettlementName

public Enumeration<? extends SettlementName> enumerateSettlementName()

Method enumerateSettlementName.

Returns:

an Enumeration over all possible elements of this collection

getSettlementName

public SettlementName getSettlementName(int index)
                                 throws IndexOutOfBoundsException

Method getSettlementName.

Parameters:

index -

Returns:

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

Throws:

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

getSettlementName

public SettlementName[] getSettlementName()

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

getSettlementNameCount

public int getSettlementNameCount()

Method getSettlementNameCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateSettlementName

public Iterator<? extends SettlementName> iterateSettlementName()

Method iterateSettlementName.

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

removeAllSettlementName

public void removeAllSettlementName()

removeSettlementName

public boolean removeSettlementName(SettlementName vSettlementName)

Method removeSettlementName.

Parameters:

vSettlementName -

Returns:

true if the object was removed from the collection.

removeSettlementNameAt

public SettlementName removeSettlementNameAt(int index)

Method removeSettlementNameAt.

Parameters:

index -

Returns:

the element removed from the collection

setSettlementName

public void setSettlementName(int index,
                              SettlementName vSettlementName)
                       throws IndexOutOfBoundsException

Parameters:

index -

vSettlementName -

Throws:

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

setSettlementName

public void setSettlementName(SettlementName[] vSettlementNameArray)

Parameters:

vSettlementNameArray -

unmarshal

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

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