org.hydrateframework.gen.schema
Class Method

java.lang.Object
  org.hydrateframework.gen.schema.SchemaElementBase
      org.hydrateframework.gen.schema.Method

All Implemented Interfaces:

SchemaElement

public class Method
extends SchemaElementBase

Version:

@(#)$Revision: 1.6 $

Author:

David Chamberlin

Nested Class Summary

class

Method.Parameter

Nested classes/interfaces inherited from interface org.hydrateframework.gen.schema.SchemaElement

SchemaElement.HighlightType

Field Summary

Fields inherited from class org.hydrateframework.gen.schema.SchemaElementBase

ATTR_MANDATORY, ATTR_MANDATORYNOOVR, ATTR_NOOVR, ATTR_OPTIONAL, ATTR_OPTIONALNOOVR, BOOL_FALSE, BOOL_NOT, BOOL_NOTSET, BOOL_TRUE, NAME, valid

Constructor Summary

Method(Family family)

Method(Family family, Method override)

Method Summary

boolean	equals(java.lang.Object o)
java.lang.String	getComment()
Family	getFamily()
SchemaElement.HighlightType	getHighlightType()
java.lang.String	getJavaEmptyRetVal()
java.lang.String[]	getJavaExceptionList()
java.lang.String	getJavaName()
java.lang.String	getJavaReturnType()
java.lang.String	getName()
SchemaElementBase	getOverrides()
Method.Parameter[]	getParameters()
java.lang.String	getReturnType()
int	hashCode()
boolean	isAbstract()
boolean	isDeprecated()
boolean	isValid(java.lang.StringBuffer reason) Determine if the schema element just read is valid.
void	notifyUpdate(SchemaElement element) Notify a schema element that the schema element it is overriding has changed
SchemaElement	override(Family family) Override the schema element from ain included file.
boolean	readFromXmlDoc(java.util.Stack<java.lang.String> readContext, org.w3c.dom.Element elem) Read the element from the DOM model
void	resolve()
void	setName(java.lang.String name)
void	setType(java.lang.String typeName)
boolean	shouldWrite()
java.lang.String	toSummary()
void	writeToXmlDoc(SAXWriter wrt) Write out this schema element to the SAX Handler

Methods inherited from class org.hydrateframework.gen.schema.SchemaElementBase

addBoolAttribute, addEnumAttribute, addIntAttribute, addListAttribute, addStringAttribute, isValidIdentifier, newElement, printAttrWarning, printWarning, readBoolAttribute, readEnumAttribute, readIntAttribute, readListAttribute, readStringAttribute, refEquals, supersedes

Methods inherited from class java.lang.Object

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

Constructor Detail

Method

public Method(Family family,
              Method override)

Method

public Method(Family family)

Method Detail

getOverrides

public SchemaElementBase getOverrides()

Specified by:

getOverrides in class SchemaElementBase

toSummary

public java.lang.String toSummary()

override

public SchemaElement override(Family family)

Description copied from interface: SchemaElement

Override the schema element from ain included file. The implementation of this method should make a new SchemaElement, that knows that it is overriding this element. It should also remember the identity of the schema element that has overridden it (i.e. the element it returns so that it can notify it via the SchemaElement.notifyUpdate(SchemaElement) method when this element changes.

Parameters:

family - the family in which the overridden element is to be created

Returns:

the new schema element that overrides this one.

getFamily

public Family getFamily()

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

getComment

public java.lang.String getComment()

setType

public void setType(java.lang.String typeName)

getReturnType

public java.lang.String getReturnType()

getJavaReturnType

public java.lang.String getJavaReturnType()

getJavaEmptyRetVal

public java.lang.String getJavaEmptyRetVal()

getJavaName

public java.lang.String getJavaName()

getParameters

public Method.Parameter[] getParameters()

isDeprecated

public boolean isDeprecated()

isAbstract

public boolean isAbstract()

getJavaExceptionList

public java.lang.String[] getJavaExceptionList()

writeToXmlDoc

public void writeToXmlDoc(SAXWriter wrt)
                   throws org.xml.sax.SAXException

Description copied from interface: SchemaElement

Write out this schema element to the SAX Handler

Throws:

org.xml.sax.SAXException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

readFromXmlDoc

public boolean readFromXmlDoc(java.util.Stack<java.lang.String> readContext,
                              org.w3c.dom.Element elem)

Description copied from interface: SchemaElement

Read the element from the DOM model

Parameters:

readContext - the context within the XML of the read operation. This is used to help pinpoint the source of an error.

elem - the DOM element to use to initialize this class.

isValid

public boolean isValid(java.lang.StringBuffer reason)

Description copied from interface: SchemaElement

Determine if the schema element just read is valid.

Parameters:

reason - the reason for the failure (or warning) if any should be appended to this string buffer.

Returns:

true if the element is valid, false otherwise.

notifyUpdate

public void notifyUpdate(SchemaElement element)

Description copied from interface: SchemaElement

Notify a schema element that the schema element it is overriding has changed

Parameters:

element - the overridden schema element.

shouldWrite

public boolean shouldWrite()

resolve

public void resolve()

getHighlightType

public SchemaElement.HighlightType getHighlightType()