uk.ac.essex.common.action.xml
Class ApplicationSettings

java.lang.Object
  uk.ac.essex.common.action.xml.ApplicationSettings

All Implemented Interfaces:

java.io.Serializable

public class ApplicationSettings
extends java.lang.Object
implements java.io.Serializable

Class ApplicationSettings.

See Also:

Serialized Form

Constructor Summary

ApplicationSettings()

Method Summary

void	addApplication(Application vApplication)
void	addApplication(int index, Application vApplication)
java.util.Enumeration<? extends Application>	enumerateApplication() Method enumerateApplication.
Application[]	getApplication() Method getApplication.Returns the contents of the collection in an Array.
Application	getApplication(int index) Method getApplication.
int	getApplicationCount() Method getApplicationCount.
boolean	isValid() Method isValid.
java.util.Iterator<? extends Application>	iterateApplication() Method iterateApplication.
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
void	removeAllApplication()
boolean	removeApplication(Application vApplication) Method removeApplication.
Application	removeApplicationAt(int index) Method removeApplicationAt.
void	setApplication(Application[] vApplicationArray)
void	setApplication(int index, Application vApplication)
static ApplicationSettings	unmarshal(java.io.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

ApplicationSettings

public ApplicationSettings()

Method Detail

addApplication

public void addApplication(Application vApplication)
                    throws java.lang.IndexOutOfBoundsException

Parameters:

vApplication -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addApplication

public void addApplication(int index,
                           Application vApplication)
                    throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vApplication -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateApplication

public java.util.Enumeration<? extends Application> enumerateApplication()

Method enumerateApplication.

Returns:

an Enumeration over all possible elements of this collection

getApplication

public Application getApplication(int index)
                           throws java.lang.IndexOutOfBoundsException

Method getApplication.

Parameters:

index -

Returns:

the value of the uk.ac.essex.common.action.xml.Application at the given index

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getApplication

public Application[] getApplication()

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

getApplicationCount

public int getApplicationCount()

Method getApplicationCount.

Returns:

the size of this collection

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateApplication

public java.util.Iterator<? extends Application> iterateApplication()

Method iterateApplication.

Returns:

an Iterator over all possible elements in this collection

marshal

public void marshal(java.io.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(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

java.io.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

removeAllApplication

public void removeAllApplication()

removeApplication

public boolean removeApplication(Application vApplication)

Method removeApplication.

Parameters:

vApplication -

Returns:

true if the object was removed from the collection.

removeApplicationAt

public Application removeApplicationAt(int index)

Method removeApplicationAt.

Parameters:

index -

Returns:

the element removed from the collection

setApplication

public void setApplication(int index,
                           Application vApplication)
                    throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vApplication -

Throws:

java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setApplication

public void setApplication(Application[] vApplicationArray)

Parameters:

vApplicationArray -

unmarshal

public static ApplicationSettings unmarshal(java.io.Reader reader)
                                     throws org.exolab.castor.xml.MarshalException,
                                            org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled uk.ac.essex.common.action.xml.ApplicationSettings

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