org.hava.engine
Class HDocComment

java.lang.Object
  org.hava.engine.HValue
      org.hava.engine.HReference
          org.hava.engine.HDocComment

public class HDocComment
extends HReference

A doc comment masquerading as an HReference so it can be included in list passed to report generator.

Field Summary

Fields inherited from class org.hava.engine.HValue

BLANK, BOOLEAN, EMPTYLIST, ERROR, FALSE, IGNORE, INTEGER, LIST, ONE, REAL, STRUCTURE, TOKEN, TRUE, TWO, ZERO

Method Summary

boolean	equals(java.lang.Object x)
java.lang.String	getImportIdentifier() Always empty string for HDocComments.
int	hashCode()
boolean	isOverridden() Always false for HDocComments.
boolean	isTable() Always false for HDocComments.
java.lang.String	toString() Returns the text content of this document comment.

Methods inherited from class org.hava.engine.HReference

getIdentifier, getValue

Methods inherited from class org.hava.engine.HValue

booleanValue, compareDefinitionRank, doubleValue, getElement, getNumElements, getParameters, getType, intValue, isBoolean, isCompound, isDouble, isIndex, isInteger, isList, isNumerical, isStructure, isToken, structField

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

equals

public boolean equals(java.lang.Object x)

Overrides:

equals in class HValue

getImportIdentifier

public java.lang.String getImportIdentifier()

Always empty string for HDocComments.

Overrides:

getImportIdentifier in class HReference

hashCode

public int hashCode()

Overrides:

hashCode in class HValue

isOverridden

public boolean isOverridden()

Always false for HDocComments.

Overrides:

isOverridden in class HReference

isTable

public boolean isTable()

Always false for HDocComments.

Overrides:

isTable in class HReference

toString

public java.lang.String toString()

Returns the text content of this document comment.

Overrides:

toString in class HReference