Class CreateAnchorsForIndexEntries

  • All Implemented Interfaces:
    java.lang.AutoCloseable, Markup, org.apache.maven.doxia.sink.Sink

    public class CreateAnchorsForIndexEntries
    extends IndexingSink
    Sink wrapper which emits anchors for each entry detected by the underlying IndexingSink. It only creates an anchor if there is no accompanying anchor detected for the according entry.
    See Also:
    TocMacro
    • Constructor Detail

      • CreateAnchorsForIndexEntries

        public CreateAnchorsForIndexEntries​(org.apache.maven.doxia.sink.Sink delegate)
    • Method Detail

      • onIndexEntry

        protected void onIndexEntry​(IndexEntry entry)
        Description copied from class: IndexingSink
        Called at the beginning of each entry (once all metadata about it is collected). The events for the metadata are buffered and only flushed after this method was called.
        Overrides:
        onIndexEntry in class IndexingSink
        Parameters:
        entry - the newly collected entry