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

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

All Implemented Interfaces:

Serializable

public class SettlementTemplateList
extends Object
implements Serializable

Class SettlementTemplateList.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SettlementTemplateList()

Method Summary

void	addTemplate(int index, Template vTemplate)
void	addTemplate(Template vTemplate)
Enumeration<? extends Template>	enumerateTemplate() Method enumerateTemplate.
Template[]	getTemplate() Method getTemplate.Returns the contents of the collection in an Array.
Template	getTemplate(int index) Method getTemplate.
int	getTemplateCount() Method getTemplateCount.
boolean	isValid() Method isValid.
Iterator<? extends Template>	iterateTemplate() Method iterateTemplate.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllTemplate()
boolean	removeTemplate(Template vTemplate) Method removeTemplate.
Template	removeTemplateAt(int index) Method removeTemplateAt.
void	setTemplate(int index, Template vTemplate)
void	setTemplate(Template[] vTemplateArray)
static SettlementTemplateList	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

SettlementTemplateList

public SettlementTemplateList()

Method Detail

addTemplate

public void addTemplate(Template vTemplate)
                 throws IndexOutOfBoundsException

Parameters:

vTemplate -

Throws:

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

addTemplate

public void addTemplate(int index,
                        Template vTemplate)
                 throws IndexOutOfBoundsException

Parameters:

index -

vTemplate -

Throws:

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

enumerateTemplate

public Enumeration<? extends Template> enumerateTemplate()

Method enumerateTemplate.

Returns:

an Enumeration over all possible elements of this collection

getTemplate

public Template getTemplate(int index)
                     throws IndexOutOfBoundsException

Method getTemplate.

Parameters:

index -

Returns:

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

Throws:

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

getTemplate

public Template[] getTemplate()

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

getTemplateCount

public int getTemplateCount()

Method getTemplateCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateTemplate

public Iterator<? extends Template> iterateTemplate()

Method iterateTemplate.

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

removeAllTemplate

public void removeAllTemplate()

removeTemplate

public boolean removeTemplate(Template vTemplate)

Method removeTemplate.

Parameters:

vTemplate -

Returns:

true if the object was removed from the collection.

removeTemplateAt

public Template removeTemplateAt(int index)

Method removeTemplateAt.

Parameters:

index -

Returns:

the element removed from the collection

setTemplate

public void setTemplate(int index,
                        Template vTemplate)
                 throws IndexOutOfBoundsException

Parameters:

index -

vTemplate -

Throws:

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

setTemplate

public void setTemplate(Template[] vTemplateArray)

Parameters:

vTemplateArray -

unmarshal

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

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