uk.ac.essex.common.keymapper.xml
Class KeyMapXML

java.lang.Object
  uk.ac.essex.common.keymapper.xml.KeyMapXML

All Implemented Interfaces:

java.io.Serializable

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

Class KeyMapXML.

See Also:

Serialized Form

Constructor Summary

KeyMapXML()

Method Summary

void	addAction(Action vAction)
void	addAction(int index, Action vAction)
java.util.Enumeration<? extends Action>	enumerateAction() Method enumerateAction.
Action[]	getAction() Method getAction.Returns the contents of the collection in an Array.
Action	getAction(int index) Method getAction.
int	getActionCount() Method getActionCount.
java.lang.String	getName() Returns the value of field 'name'.
java.lang.String	getParentMap() Returns the value of field 'parentMap'.
boolean	isValid() Method isValid.
java.util.Iterator<? extends Action>	iterateAction() Method iterateAction.
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
boolean	removeAction(Action vAction) Method removeAction.
Action	removeActionAt(int index) Method removeActionAt.
void	removeAllAction()
void	setAction(Action[] vActionArray)
void	setAction(int index, Action vAction)
void	setName(java.lang.String name) Sets the value of field 'name'.
void	setParentMap(java.lang.String parentMap) Sets the value of field 'parentMap'.
static KeyMapXML	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

KeyMapXML

public KeyMapXML()

Method Detail

addAction

public void addAction(Action vAction)
               throws java.lang.IndexOutOfBoundsException

Parameters:

vAction -

Throws:

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

addAction

public void addAction(int index,
                      Action vAction)
               throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vAction -

Throws:

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

enumerateAction

public java.util.Enumeration<? extends Action> enumerateAction()

Method enumerateAction.

Returns:

an Enumeration over all possible elements of this collection

getAction

public Action getAction(int index)
                 throws java.lang.IndexOutOfBoundsException

Method getAction.

Parameters:

index -

Returns:

the value of the uk.ac.essex.common.keymapper.xml.Action at the given index

Throws:

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

getAction

public Action[] getAction()

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

getActionCount

public int getActionCount()

Method getActionCount.

Returns:

the size of this collection

getName

public java.lang.String getName()

Returns the value of field 'name'.

Returns:

the value of field 'Name'.

getParentMap

public java.lang.String getParentMap()

Returns the value of field 'parentMap'.

Returns:

the value of field 'ParentMap'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

iterateAction

public java.util.Iterator<? extends Action> iterateAction()

Method iterateAction.

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

removeAction

public boolean removeAction(Action vAction)

Method removeAction.

Parameters:

vAction -

Returns:

true if the object was removed from the collection.

removeActionAt

public Action removeActionAt(int index)

Method removeActionAt.

Parameters:

index -

Returns:

the element removed from the collection

removeAllAction

public void removeAllAction()

setAction

public void setAction(int index,
                      Action vAction)
               throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vAction -

Throws:

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

setAction

public void setAction(Action[] vActionArray)

Parameters:

vActionArray -

setName

public void setName(java.lang.String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setParentMap

public void setParentMap(java.lang.String parentMap)

Sets the value of field 'parentMap'.

Parameters:

parentMap - the value of field 'parentMap'.

unmarshal

public static KeyMapXML 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.keymapper.xml.KeyMapXML

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