org.exolab.castor.mapping.xml

Class FieldHandlerDef

Implemented Interfaces:
java.io.Serializable

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

Class FieldHandlerDef.
Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary

FieldHandlerDef()

Method Summary

void
addParam(int index, Param vParam)
void
addParam(Param vParam)
java.util.Enumeration
enumerateParam()
Method enumerateParam.
java.lang.String
getClazz()
Returns the value of field 'clazz'.
java.lang.String
getName()
Returns the value of field 'name'.
Param[]
getParam()
Method getParam.Returns the contents of the collection in an Array.
Param
getParam(int index)
Method getParam.
int
getParamCount()
Method getParamCount.
boolean
isValid()
Method isValid.
java.util.Iterator
iterateParam()
Method iterateParam.
void
marshal(java.io.Writer out)
void
marshal(org.xml.sax.ContentHandler handler)
void
removeAllParam()
boolean
removeParam(Param vParam)
Method removeParam.
Param
removeParamAt(int index)
Method removeParamAt.
void
setClazz(java.lang.String clazz)
Sets the value of field 'clazz'.
void
setName(java.lang.String name)
Sets the value of field 'name'.
void
setParam(int index, Param vParam)
void
setParam(Param[] vParamArray)
static FieldHandlerDef
unmarshal(java.io.Reader reader)
Method unmarshal.
void
validate()

Constructor Details

FieldHandlerDef

public FieldHandlerDef()

Method Details

addParam

public void addParam(int index,
                     Param vParam)
            throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vParam -

addParam

public void addParam(Param vParam)
            throws java.lang.IndexOutOfBoundsException
Parameters:
vParam -

enumerateParam

public java.util.Enumeration enumerateParam()
Method enumerateParam.
Returns:
an Enumeration over all possible elements of this collection

getClazz

public java.lang.String getClazz()
Returns the value of field 'clazz'.
Returns:
the value of field 'Clazz'.

getName

public java.lang.String getName()
Returns the value of field 'name'.
Returns:
the value of field 'Name'.

getParam

public Param[] getParam()
Method getParam.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

getParam

public Param getParam(int index)
            throws java.lang.IndexOutOfBoundsException
Method getParam.
Parameters:
index -
Returns:
the value of the org.exolab.castor.mapping.xml.Param at the given index

getParamCount

public int getParamCount()
Method getParamCount.
Returns:
the size of this collection

isValid

public boolean isValid()
Method isValid.
Returns:
true if this object is valid according to the schema

iterateParam

public java.util.Iterator iterateParam()
Method iterateParam.
Returns:
an Iterator over all possible elements in this collection

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:
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

removeAllParam

public void removeAllParam()

removeParam

public boolean removeParam(Param vParam)
Method removeParam.
Parameters:
vParam -
Returns:
true if the object was removed from the collection.

removeParamAt

public Param removeParamAt(int index)
Method removeParamAt.
Parameters:
index -
Returns:
the element removed from the collection

setClazz

public void setClazz(java.lang.String clazz)
Sets the value of field 'clazz'.
Parameters:
clazz - the value of field 'clazz'.

setName

public void setName(java.lang.String name)
Sets the value of field 'name'.
Parameters:
name - the value of field 'name'.

setParam

public void setParam(int index,
                     Param vParam)
            throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vParam -

setParam

public void setParam(Param[] vParamArray)
Parameters:
vParamArray -

unmarshal

public static FieldHandlerDef unmarshal(java.io.Reader reader)
            throws MarshalException,
                   ValidationException
Method unmarshal.
Parameters:
reader -
Returns:
the unmarshaled org.exolab.castor.mapping.xml.FieldHandlerDef
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-2008. All rights reserved http://www.intalio.com