Package org.exolab.castor.mapping.xml
Class KeyGeneratorDef
- java.lang.Object
-
- org.exolab.castor.mapping.xml.KeyGeneratorDef
-
- All Implemented Interfaces:
java.io.Serializable
public class KeyGeneratorDef extends java.lang.Object implements java.io.Serializable
Class KeyGeneratorDef.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description KeyGeneratorDef()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addParam(int index, Param vParam)
void
addParam(Param vParam)
java.util.Enumeration<? extends Param>
enumerateParam()
Method enumerateParam.java.lang.String
getAlias()
Returns the value of field 'alias'.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<? extends Param>
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
setAlias(java.lang.String alias)
Sets the value of field 'alias'.void
setName(java.lang.String name)
Sets the value of field 'name'.void
setParam(int index, Param vParam)
void
setParam(Param[] vParamArray)
static KeyGeneratorDef
unmarshal(java.io.Reader reader)
Method unmarshal.void
validate()
-
-
-
Method Detail
-
addParam
public void addParam(Param vParam) throws java.lang.IndexOutOfBoundsException
- Parameters:
vParam
-- Throws:
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
addParam
public void addParam(int index, Param vParam) throws java.lang.IndexOutOfBoundsException
- Parameters:
index
-vParam
-- Throws:
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
enumerateParam
public java.util.Enumeration<? extends Param> enumerateParam()
Method enumerateParam.- Returns:
- an Enumeration over all possible elements of this collection
-
getAlias
public java.lang.String getAlias()
Returns the value of field 'alias'.- Returns:
- the value of field 'Alias'.
-
getName
public java.lang.String getName()
Returns the value of field 'name'.- Returns:
- the value of field 'Name'.
-
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
- Throws:
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
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
-
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<? extends Param> 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 marshalingValidationException
- 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 marshalingValidationException
- if this object is an invalid instance according to the schemaMarshalException
- 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
-
setAlias
public void setAlias(java.lang.String alias)
Sets the value of field 'alias'.- Parameters:
alias
- the value of field 'alias'.
-
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
-- Throws:
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
setParam
public void setParam(Param[] vParamArray)
- Parameters:
vParamArray
-
-
unmarshal
public static KeyGeneratorDef unmarshal(java.io.Reader reader) throws MarshalException, ValidationException
Method unmarshal.- Parameters:
reader
-- Returns:
- the unmarshaled org.exolab.castor.mapping.xml.KeyGeneratorDef
- Throws:
MarshalException
- if object is null or if any SAXException is thrown during marshalingValidationException
- 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
-
-