org.exolab.castor.tests.framework.testDescriptor
Class ConfigurationType

java.lang.Object
  extended by org.exolab.castor.tests.framework.testDescriptor.ConfigurationType
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
Marshal, Methods, Unmarshal

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

Configuration for marshaling or unmarshaling or source generation. Contains a list of methods to be called on the marshaler or unmarshaler or source generator with the parameters to be provided for each method.

Version:
$Revision: 6767 $ $Date$
See Also:
Serialized Form

Constructor Summary
ConfigurationType()
           
 
Method Summary
 void addCallMethod(CallMethod vCallMethod)
           
 void addCallMethod(int index, CallMethod vCallMethod)
           
 java.util.Enumeration enumerateCallMethod()
          Method enumerateCallMethod.
 CallMethod[] getCallMethod()
          Method getCallMethod.Returns the contents of the collection in an Array.
 CallMethod getCallMethod(int index)
          Method getCallMethod.
 int getCallMethodCount()
          Method getCallMethodCount.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllCallMethod()
           
 boolean removeCallMethod(CallMethod vCallMethod)
          Method removeCallMethod.
 CallMethod removeCallMethodAt(int index)
          Method removeCallMethodAt.
 void setCallMethod(CallMethod[] vCallMethodArray)
           
 void setCallMethod(int index, CallMethod vCallMethod)
           
static ConfigurationType 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

ConfigurationType

public ConfigurationType()
Method Detail

addCallMethod

public void addCallMethod(CallMethod vCallMethod)
                   throws java.lang.IndexOutOfBoundsException
Parameters:
vCallMethod -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addCallMethod

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

enumerateCallMethod

public java.util.Enumeration enumerateCallMethod()
Method enumerateCallMethod.

Returns:
an Enumeration over all org.exolab.castor.tests.framework.testDescriptor.CallMethod elements

getCallMethod

public CallMethod getCallMethod(int index)
                         throws java.lang.IndexOutOfBoundsException
Method getCallMethod.

Parameters:
index -
Returns:
the value of the org.exolab.castor.tests.framework.testDescriptor.CallMethod at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getCallMethod

public CallMethod[] getCallMethod()
Method getCallMethod.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

getCallMethodCount

public int getCallMethodCount()
Method getCallMethodCount.

Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.

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

marshal

public void marshal(java.io.Writer out)
             throws MarshalException,
                    ValidationException
Parameters:
out -
Throws:
MarshalException - if object is null or if any SAXException is thrown during marshaling
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,
                    MarshalException,
                    ValidationException
Parameters:
handler -
Throws:
java.io.IOException - if an IOException occurs during marshaling
ValidationException - if this object is an invalid instance according to the schema
MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllCallMethod

public void removeAllCallMethod()

removeCallMethod

public boolean removeCallMethod(CallMethod vCallMethod)
Method removeCallMethod.

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

removeCallMethodAt

public CallMethod removeCallMethodAt(int index)
Method removeCallMethodAt.

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

setCallMethod

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

setCallMethod

public void setCallMethod(CallMethod[] vCallMethodArray)
Parameters:
vCallMethodArray -

unmarshal

public static ConfigurationType unmarshal(java.io.Reader reader)
                                   throws MarshalException,
                                          ValidationException
Method unmarshal.

Parameters:
reader -
Returns:
the unmarshaled org.exolab.castor.tests.framework.testDescriptor.ConfigurationType
Throws:
MarshalException - if object is null or if any SAXException is thrown during marshaling
ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws ValidationException
Throws:
ValidationException - if this object is an invalid instance according to the schema


Intalio Inc. (C) 1999-2007. All rights reserved http://www.intalio.com