org.mars_sim.msp.config.model.construction
Class BuildingList

java.lang.Object
  org.mars_sim.msp.config.model.construction.BuildingList

All Implemented Interfaces:

Serializable

public class BuildingList
extends Object
implements Serializable

Class BuildingList.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

BuildingList()

Method Summary

void	addBuilding(Building vBuilding)
void	addBuilding(int index, Building vBuilding)
Enumeration<? extends Building>	enumerateBuilding() Method enumerateBuilding.
Building[]	getBuilding() Method getBuilding.Returns the contents of the collection in an Array.
Building	getBuilding(int index) Method getBuilding.
int	getBuildingCount() Method getBuildingCount.
boolean	isValid() Method isValid.
Iterator<? extends Building>	iterateBuilding() Method iterateBuilding.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllBuilding()
boolean	removeBuilding(Building vBuilding) Method removeBuilding.
Building	removeBuildingAt(int index) Method removeBuildingAt.
void	setBuilding(Building[] vBuildingArray)
void	setBuilding(int index, Building vBuilding)
static BuildingList	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

BuildingList

public BuildingList()

Method Detail

addBuilding

public void addBuilding(Building vBuilding)
                 throws IndexOutOfBoundsException

Parameters:

vBuilding -

Throws:

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

addBuilding

public void addBuilding(int index,
                        Building vBuilding)
                 throws IndexOutOfBoundsException

Parameters:

index -

vBuilding -

Throws:

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

enumerateBuilding

public Enumeration<? extends Building> enumerateBuilding()

Method enumerateBuilding.

Returns:

an Enumeration over all possible elements of this collection

getBuilding

public Building getBuilding(int index)
                     throws IndexOutOfBoundsException

Method getBuilding.

Parameters:

index -

Returns:

the value of the org.mars_sim.msp.config.model.construction.Building at the given index

Throws:

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

getBuilding

public Building[] getBuilding()

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

getBuildingCount

public int getBuildingCount()

Method getBuildingCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateBuilding

public Iterator<? extends Building> iterateBuilding()

Method iterateBuilding.

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

removeAllBuilding

public void removeAllBuilding()

removeBuilding

public boolean removeBuilding(Building vBuilding)

Method removeBuilding.

Parameters:

vBuilding -

Returns:

true if the object was removed from the collection.

removeBuildingAt

public Building removeBuildingAt(int index)

Method removeBuildingAt.

Parameters:

index -

Returns:

the element removed from the collection

setBuilding

public void setBuilding(int index,
                        Building vBuilding)
                 throws IndexOutOfBoundsException

Parameters:

index -

vBuilding -

Throws:

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

setBuilding

public void setBuilding(Building[] vBuildingArray)

Parameters:

vBuildingArray -

unmarshal

public static BuildingList 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.construction.BuildingList

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