Class TOCItemReference

  • All Implemented Interfaces:
    java.lang.Comparable<TOCItemReference>

    public class TOCItemReference
    extends TOCItem
    implements java.lang.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.
    • Constructor Detail

      • TOCItemReference

        public TOCItemReference​(TOCItem parentItem,
                                java.nio.file.Path sourceTOCFile,
                                java.lang.String ID,
                                int lineNumber)
    • Method Detail

      • getTargetAttribute

        public java.lang.String getTargetAttribute()
        Overridden, as references cannot have targets, only their definitions
        Overrides:
        getTargetAttribute in class TOCItem
      • generateTOCItemTag

        public java.lang.String generateTOCItemTag​(LinkDatabase linkDatabase,
                                                   boolean isInlineTag,
                                                   int indentLevel)
        Overridden, as if we get called, then something is in an invalid state, so generate special output
        Overrides:
        generateTOCItemTag in class TOCItem
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object