org.mars_sim.msp.config.model.mineral
Class LocaleList

java.lang.Object
  org.mars_sim.msp.config.model.mineral.LocaleList

All Implemented Interfaces:

Serializable

public class LocaleList
extends Object
implements Serializable

Class LocaleList.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

LocaleList()

Method Summary

void	addLocale(int index, Locale vLocale)
void	addLocale(Locale vLocale)
Enumeration<? extends Locale>	enumerateLocale() Method enumerateLocale.
Locale[]	getLocale() Method getLocale.Returns the contents of the collection in an Array.
Locale	getLocale(int index) Method getLocale.
int	getLocaleCount() Method getLocaleCount.
boolean	isValid() Method isValid.
Iterator<? extends Locale>	iterateLocale() Method iterateLocale.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllLocale()
boolean	removeLocale(Locale vLocale) Method removeLocale.
Locale	removeLocaleAt(int index) Method removeLocaleAt.
void	setLocale(int index, Locale vLocale)
void	setLocale(Locale[] vLocaleArray)
static LocaleList	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

LocaleList

public LocaleList()

Method Detail

addLocale

public void addLocale(Locale vLocale)
               throws IndexOutOfBoundsException

Parameters:

vLocale -

Throws:

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

addLocale

public void addLocale(int index,
                      Locale vLocale)
               throws IndexOutOfBoundsException

Parameters:

index -

vLocale -

Throws:

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

enumerateLocale

public Enumeration<? extends Locale> enumerateLocale()

Method enumerateLocale.

Returns:

an Enumeration over all possible elements of this collection

getLocale

public Locale getLocale(int index)
                 throws IndexOutOfBoundsException

Method getLocale.

Parameters:

index -

Returns:

the value of the org.mars_sim.msp.config.model.mineral.Locale at the given index

Throws:

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

getLocale

public Locale[] getLocale()

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

getLocaleCount

public int getLocaleCount()

Method getLocaleCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateLocale

public Iterator<? extends Locale> iterateLocale()

Method iterateLocale.

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

removeAllLocale

public void removeAllLocale()

removeLocale

public boolean removeLocale(Locale vLocale)

Method removeLocale.

Parameters:

vLocale -

Returns:

true if the object was removed from the collection.

removeLocaleAt

public Locale removeLocaleAt(int index)

Method removeLocaleAt.

Parameters:

index -

Returns:

the element removed from the collection

setLocale

public void setLocale(int index,
                      Locale vLocale)
               throws IndexOutOfBoundsException

Parameters:

index -

vLocale -

Throws:

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

setLocale

public void setLocale(Locale[] vLocaleArray)

Parameters:

vLocaleArray -

unmarshal

public static LocaleList 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.mineral.LocaleList

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