Package help.validator.model
Class TOCItemReference
java.lang.Object
help.validator.model.TOCItem
help.validator.model.TOCItemReference
- All Implemented Interfaces:
Comparable<TOCItemReference>
A representation of the <tocref> tag, which is a way to reference a TOC item entry in
a TOC_Source.xml file other than the one in which the reference lives.
-
Field Summary
Fields inherited from class help.validator.model.TOCItem
INDENTS, parentItem, targetAttribute, textAttribute, TOC_ITEM_CLOSE_TAG
-
Constructor Summary
ConstructorDescriptionTOCItemReference
(TOCItem parentItem, Path sourceTOCFile, String ID, int lineNumber) -
Method Summary
Modifier and TypeMethodDescriptionint
compareTo
(TOCItemReference other) generateTOCItemTag
(LinkDatabase linkDatabase, boolean isInlineTag, int indentLevel) Overridden, as if we get called, then something is in an invalid state, so generate special outputOverridden, as references cannot have targets, only their definitionstoString()
boolean
validate
(LinkDatabase linkDatabase) Methods inherited from class help.validator.model.TOCItem
addChild, childCount, equals, generateEndTag, getChildren, getIDAttribute, getLineNumber, getParent, getSortPreference, getSourceFile, getTextAttribute, hashCode, isEquivalent, printChildren, printChildren, removeChild, writeContents, writeContents
-
Constructor Details
-
TOCItemReference
-
-
Method Details
-
validate
-
getTargetAttribute
Overridden, as references cannot have targets, only their definitions- Overrides:
getTargetAttribute
in classTOCItem
-
generateTOCItemTag
Overridden, as if we get called, then something is in an invalid state, so generate special output- Overrides:
generateTOCItemTag
in classTOCItem
-
compareTo
- Specified by:
compareTo
in interfaceComparable<TOCItemReference>
-
toString
-