org.exolab.castor.builder.binding

Class ClassType

java.lang.Object

org.exolab.castor.builder.binding.ClassType

All Implemented Interfaces:

java.io.Serializable

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

This type gathers the needed information to generate a Java Class from a binding file. Options such as generating the equals method, using wrapper classes for primitives or using bound properties can be defined via that element. When defined locally the options override the values defined in the castor.properties file.

Version:

$Revision: 5951 $ $Date: 2005-03-05 06:42:06 -0700 (Sat, 05 Mar 2005) $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClassType()

Method Summary

Modifier and Type	Method and Description
void	addImplements(int index, java.lang.String vImplements)
void	addImplements(java.lang.String vImplements)
void	deleteAbstract()
void	deleteBound()
void	deleteEquals()
void	deleteFinal()
java.util.Enumeration	enumerateImplements()
boolean	getAbstract() Returns the value of field 'abstract'.
boolean	getBound() Returns the value of field 'bound'.
boolean	getEquals() Returns the value of field 'equals'.
java.lang.String	getExtends() Returns the value of field 'extends'.
boolean	getFinal() Returns the value of field 'final'.
java.lang.String[]	getImplements()
java.lang.String	getImplements(int index)
int	getImplementsCount()
java.lang.String	getName() Returns the value of field 'name'.
java.lang.String	getPackage() Returns the value of field 'package'.
boolean	hasAbstract()
boolean	hasBound()
boolean	hasEquals()
boolean	hasFinal()
boolean	isValid()
void	marshal(org.xml.sax.ContentHandler handler)
void	marshal(java.io.Writer out)
void	removeAllImplements()
java.lang.String	removeImplements(int index)
void	setAbstract(boolean _abstract) Sets the value of field 'abstract'.
void	setBound(boolean bound) Sets the value of field 'bound'.
void	setEquals(boolean equals) Sets the value of field 'equals'.
void	setExtends(java.lang.String _extends) Sets the value of field 'extends'.
void	setFinal(boolean _final) Sets the value of field 'final'.
void	setImplements(int index, java.lang.String vImplements)
void	setImplements(java.lang.String[] _implementsArray)
void	setName(java.lang.String name) Sets the value of field 'name'.
void	setPackage(java.lang.String _package) Sets the value of field 'package'.
static ClassType	unmarshalClassType(java.io.Reader reader)
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassType

public ClassType()

Method Detail

addImplements

public void addImplements(java.lang.String vImplements)
                   throws java.lang.IndexOutOfBoundsException

Parameters:

vImplements -

Throws:

java.lang.IndexOutOfBoundsException

addImplements

public void addImplements(int index,
                          java.lang.String vImplements)
                   throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vImplements -

Throws:

java.lang.IndexOutOfBoundsException

deleteAbstract

public void deleteAbstract()

deleteBound

public void deleteBound()

deleteEquals

public void deleteEquals()

deleteFinal

public void deleteFinal()

enumerateImplements

public java.util.Enumeration enumerateImplements()

getAbstract

public boolean getAbstract()

Returns the value of field 'abstract'.

Returns:

the value of field 'abstract'.

getBound

public boolean getBound()

Returns the value of field 'bound'.

Returns:

the value of field 'bound'.

getEquals

public boolean getEquals()

Returns the value of field 'equals'.

Returns:

the value of field 'equals'.

getExtends

public java.lang.String getExtends()

Returns the value of field 'extends'.

Returns:

the value of field 'extends'.

getFinal

public boolean getFinal()

Returns the value of field 'final'.

Returns:

the value of field 'final'.

getImplements

public java.lang.String getImplements(int index)
                               throws java.lang.IndexOutOfBoundsException

Parameters:

index -

Throws:

java.lang.IndexOutOfBoundsException

getImplements

public java.lang.String[] getImplements()

getImplementsCount

public int getImplementsCount()

getName

public java.lang.String getName()

Returns the value of field 'name'.

Returns:

the value of field 'name'.

getPackage

public java.lang.String getPackage()

Returns the value of field 'package'.

Returns:

the value of field 'package'.

hasAbstract

public boolean hasAbstract()

hasBound

public boolean hasBound()

hasEquals

public boolean hasEquals()

hasFinal

public boolean hasFinal()

isValid

public boolean isValid()

marshal

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

Parameters:

out -

Throws:

MarshalException

ValidationException

marshal

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

Parameters:

handler -

Throws:

java.io.IOException

MarshalException

ValidationException

removeAllImplements

public void removeAllImplements()

removeImplements

public java.lang.String removeImplements(int index)

Parameters:

index -

setAbstract

public void setAbstract(boolean _abstract)

Sets the value of field 'abstract'.

Parameters:

_abstract - the value of field 'abstract'.

setBound

public void setBound(boolean bound)

Sets the value of field 'bound'.

Parameters:

bound - the value of field 'bound'.

setEquals

public void setEquals(boolean equals)

Sets the value of field 'equals'.

Parameters:

equals - the value of field 'equals'.

setExtends

public void setExtends(java.lang.String _extends)

Sets the value of field 'extends'.

Parameters:

_extends - the value of field 'extends'.

setFinal

public void setFinal(boolean _final)

Sets the value of field 'final'.

Parameters:

_final - the value of field 'final'.

setImplements

public void setImplements(int index,
                          java.lang.String vImplements)
                   throws java.lang.IndexOutOfBoundsException

Parameters:

index -

vImplements -

Throws:

java.lang.IndexOutOfBoundsException

setImplements

public void setImplements(java.lang.String[] _implementsArray)

Parameters:

_implementsArray -

setName

public void setName(java.lang.String name)

Sets the value of field 'name'.

Parameters:

name - the value of field 'name'.

setPackage

public void setPackage(java.lang.String _package)

Sets the value of field 'package'.

Parameters:

_package - the value of field 'package'.

unmarshalClassType

public static ClassType unmarshalClassType(java.io.Reader reader)
                                    throws MarshalException,
                                           ValidationException

Parameters:

reader -

Throws:

MarshalException

ValidationException

validate

public void validate()
              throws ValidationException

Throws:

ValidationException