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: 6104 $ $Date: 2006-01-07 15:48:31 -0700 (Sat, 07 Jan 2006) $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KeyGeneratorDef()

Method Summary

Modifier and Type	Method and Description
void	addParam(int index, Param vParam) Method addParam
void	addParam(Param vParam) Method addParam
void	clearParam() Method clearParam
java.util.Enumeration	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
Param	getParam(int index) Method getParam
int	getParamCount() Method getParamCount
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
boolean	removeParam(Param vParam) Method removeParam
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) Method setParam
void	setParam(Param[] paramArray) Method setParam
static KeyGeneratorDef	unmarshal(java.io.Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyGeneratorDef

public KeyGeneratorDef()

Method Detail

addParam

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

Method addParam

Parameters:

vParam -

Throws:

java.lang.IndexOutOfBoundsException

addParam

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

Method addParam

Parameters:

index -

vParam -

Throws:

java.lang.IndexOutOfBoundsException

clearParam

public void clearParam()

Method clearParam

enumerateParam

public java.util.Enumeration enumerateParam()

Method enumerateParam

Returns:

Enumeration

getAlias

public java.lang.String getAlias()

Returns the value of field 'alias'.

Returns:

String

getName

public java.lang.String getName()

Returns the value of field 'name'.

Returns:

String

getParam

public Param getParam(int index)
               throws java.lang.IndexOutOfBoundsException

Method getParam

Parameters:

index -

Returns:

Param

Throws:

java.lang.IndexOutOfBoundsException

getParam

public Param[] getParam()

Method getParam

Returns:

Param

getParamCount

public int getParamCount()

Method getParamCount

Returns:

int

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(java.io.Writer out)
             throws MarshalException,
                    ValidationException

Method marshal

Parameters:

out -

Throws:

MarshalException

ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    MarshalException,
                    ValidationException

Method marshal

Parameters:

handler -

Throws:

java.io.IOException

MarshalException

ValidationException

removeParam

public boolean removeParam(Param vParam)

Method removeParam

Parameters:

vParam -

Returns:

boolean

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

Method setParam

Parameters:

index -

vParam -

Throws:

java.lang.IndexOutOfBoundsException

setParam

public void setParam(Param[] paramArray)

Method setParam

Parameters:

paramArray -

unmarshal

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

Method unmarshal

Parameters:

reader -

Returns:

KeyGeneratorDef

Throws:

MarshalException

ValidationException

validate

public void validate()
              throws ValidationException

Method validate

Throws:

ValidationException