Package org.eigenbase.resgen

Class ResourceDef.Exception

java.lang.Object

org.eigenbase.xom.ElementDef

org.eigenbase.resgen.ResourceDef.Resource

org.eigenbase.resgen.ResourceDef.Exception

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, NodeDef

Enclosing class:

ResourceDef

public static class ResourceDef.Exception
extends ResourceDef.Resource

An exception defines a message which is issued in response to some invalid condition. It has a type, which must be derived from Throwable. The generated newExceptionName method creates an instance of this exception with the appropriate parameters.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
DOMWrapper	_def
java.lang.String	className
java.lang.String	cppChainExceptions
java.lang.String	cppClassLocation
java.lang.String	cppClassName

Fields inherited from class org.eigenbase.resgen.ResourceDef.Resource

name, properties, text

Constructor Summary

Constructors

Constructor	Description
Exception()
Exception(DOMWrapper _def)

Method Summary

Modifier and Type	Method	Description
void	display(java.io.PrintWriter _out, int _indent)	Outputs this node to any PrintWriter, in a formatted fashion with automatic indenting.
boolean	displayDiff(ElementDef _other, java.io.PrintWriter _out, int _indent)	The displayDiff function compares this element definition against another, compiling a message containing all diffs.
void	displayXML(XMLOutput _out, int _indent)	Outputs this element definition in XML to any XMLOutput.
(package private) DOMWrapper	getDef()
java.lang.String	getName()	Returns the name of this node's tag.

Methods inherited from class org.eigenbase.xom.ElementDef

addChild, addChildren, clone, constructElement, constructElement, deepCopy, diff, displayAttribute, displayAttributeDiff, displayElement, displayElementArray, displayElementArrayDiff, displayElementDiff, displayIndent, displayString, displayStringArray, displayStringArrayDiff, displayStringDiff, displayXML, displayXMLElement, displayXMLElementArray, displayXMLString, displayXMLStringArray, equals, getChildren, getElementChildren, getElementClass, getLocation, getMixedChildren, getMixedChildren_new, getText, getType, getWrapper, hashCode, toCompactXML, toString, toXML, verifyEqual

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

className

public java.lang.String className

cppClassName

public java.lang.String cppClassName

cppClassLocation

public java.lang.String cppClassLocation

cppChainExceptions

public java.lang.String cppChainExceptions

_def

public DOMWrapper _def

Constructor Detail

Exception

public Exception()

Exception

public Exception(DOMWrapper _def)
          throws XOMException

Throws:

XOMException

Method Detail

getName

public java.lang.String getName()

Description copied from interface: NodeDef

Returns the name of this node's tag.

Specified by:

getName in interface NodeDef

Overrides:

getName in class ResourceDef.Resource

display

public void display(java.io.PrintWriter _out,
                    int _indent)

Description copied from interface: NodeDef

Outputs this node to any PrintWriter, in a formatted fashion with automatic indenting.

Specified by:

display in interface NodeDef

Overrides:

display in class ResourceDef.Resource

Parameters:

_out - the PrintWriter to which to write this NodeDef.

_indent - the indentation level for the printout.

displayXML

public void displayXML(XMLOutput _out,
                       int _indent)

Description copied from interface: NodeDef

Outputs this element definition in XML to any XMLOutput.

Specified by:

displayXML in interface NodeDef

Overrides:

displayXML in class ResourceDef.Resource

Parameters:

_out - the XMLOutput class to display the XML

displayDiff

public boolean displayDiff(ElementDef _other,
                           java.io.PrintWriter _out,
                           int _indent)

Description copied from class: ElementDef

The displayDiff function compares this element definition against another, compiling a message containing all diffs. It is used internally by the equals(), diff(), and verifyEquals() functions.

Overrides:

displayDiff in class ResourceDef.Resource

Parameters:

_other - the ElementDef to which to compare this element.

_out - a PrintWriter to which to display any discovered differences, or null if just doing an equality check (and no diff report is needed).

_indent - the current indentation level (used for nice display of diffs).

Returns:

true if this and other match exactly, false if not.

getDef

DOMWrapper getDef()

Specified by:

getDef in class ResourceDef.Resource