Package org.exolab.castor.mapping.xml
Class KeyGeneratorDef
java.lang.Object
org.exolab.castor.mapping.xml.KeyGeneratorDef
- All Implemented Interfaces:
Serializable
- Version:
- $Revision$ $Date$
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
Enumeration<? extends Param>
Method enumerateParam.getAlias()
Returns the value of field 'alias'.getName()
Returns the value of field 'name'.Param[]
getParam()
Method getParam.Returns the contents of the collection in an Array.getParam
(int index) Method getParam.int
Method getParamCount.boolean
isValid()
Method isValid.Method iterateParam.void
void
marshal
(ContentHandler handler) void
boolean
removeParam
(Param vParam) Method removeParam.removeParamAt
(int index) Method removeParamAt.void
Sets the value of field 'alias'.void
Sets the value of field 'name'.void
void
static KeyGeneratorDef
Method unmarshal.void
validate()
-
Constructor Details
-
KeyGeneratorDef
public KeyGeneratorDef()
-
-
Method Details
-
addParam
- Parameters:
vParam
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
addParam
- Parameters:
index
-vParam
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
enumerateParam
Method enumerateParam.- Returns:
- an Enumeration over all possible elements of this collection
-
getAlias
Returns the value of field 'alias'.- Returns:
- the value of field 'Alias'.
-
getName
Returns the value of field 'name'.- Returns:
- the value of field 'Name'.
-
getParam
Method getParam.- Parameters:
index
-- Returns:
- the value of the org.exolab.castor.mapping.xml.Param at the given index
- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
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
Method iterateParam.- Returns:
- an Iterator over all possible elements in this collection
-
marshal
- 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(ContentHandler handler) throws IOException, MarshalException, ValidationException - Parameters:
handler
-- Throws:
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
Method removeParam.- Parameters:
vParam
-- Returns:
- true if the object was removed from the collection.
-
removeParamAt
Method removeParamAt.- Parameters:
index
-- Returns:
- the element removed from the collection
-
setAlias
Sets the value of field 'alias'.- Parameters:
alias
- the value of field 'alias'.
-
setName
Sets the value of field 'name'.- Parameters:
name
- the value of field 'name'.
-
setParam
- Parameters:
index
-vParam
-- Throws:
IndexOutOfBoundsException
- if the index given is outside the bounds of the collection
-
setParam
- Parameters:
vParamArray
-
-
unmarshal
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
- Throws:
ValidationException
- if this object is an invalid instance according to the schema
-