uk.ac.essex.ia.opview.xml
Class AcceptsInput

java.lang.Object
  extended by uk.ac.essex.ia.opview.xml.AcceptsInput
All Implemented Interfaces:
java.io.Serializable

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

Class AcceptsInput.

See Also:
Serialized Form

Constructor Summary
AcceptsInput()
           
 
Method Summary
 void addClassName(int index, java.lang.String vClassName)
           
 void addClassName(java.lang.String vClassName)
           
 java.util.Enumeration<? extends java.lang.String> enumerateClassName()
          Method enumerateClassName.
 java.lang.String[] getClassName()
          Method getClassName.Returns the contents of the collection in an Array.
 java.lang.String getClassName(int index)
          Method getClassName.
 int getClassNameCount()
          Method getClassNameCount.
 boolean isValid()
          Method isValid.
 java.util.Iterator<? extends java.lang.String> iterateClassName()
          Method iterateClassName.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllClassName()
           
 boolean removeClassName(java.lang.String vClassName)
          Method removeClassName.
 java.lang.String removeClassNameAt(int index)
          Method removeClassNameAt.
 void setClassName(int index, java.lang.String vClassName)
           
 void setClassName(java.lang.String[] vClassNameArray)
           
static AcceptsInput 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

AcceptsInput

public AcceptsInput()
Method Detail

addClassName

public void addClassName(java.lang.String vClassName)
                  throws java.lang.IndexOutOfBoundsException
Parameters:
vClassName -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addClassName

public void addClassName(int index,
                         java.lang.String vClassName)
                  throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vClassName -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateClassName

public java.util.Enumeration<? extends java.lang.String> enumerateClassName()
Method enumerateClassName.

Returns:
an Enumeration over all possible elements of this collection

getClassName

public java.lang.String getClassName(int index)
                              throws java.lang.IndexOutOfBoundsException
Method getClassName.

Parameters:
index -
Returns:
the value of the java.lang.String at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getClassName

public java.lang.String[] getClassName()
Method getClassName.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

getClassNameCount

public int getClassNameCount()
Method getClassNameCount.

Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.

Returns:
true if this object is valid according to the schema

iterateClassName

public java.util.Iterator<? extends java.lang.String> iterateClassName()
Method iterateClassName.

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

removeAllClassName

public void removeAllClassName()

removeClassName

public boolean removeClassName(java.lang.String vClassName)
Method removeClassName.

Parameters:
vClassName -
Returns:
true if the object was removed from the collection.

removeClassNameAt

public java.lang.String removeClassNameAt(int index)
Method removeClassNameAt.

Parameters:
index -
Returns:
the element removed from the collection

setClassName

public void setClassName(int index,
                         java.lang.String vClassName)
                  throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vClassName -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setClassName

public void setClassName(java.lang.String[] vClassNameArray)
Parameters:
vClassNameArray -

unmarshal

public static AcceptsInput 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.ia.opview.xml.AcceptsInpu
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