Package org.htmlunit.cyberneko.xerces.xni

Interface Augmentations

public interface Augmentations
The Augmentations interface defines a table of additional data that may be passed along the document pipeline. The information can contain extra arguments or infoset augmentations, for example PSVI. This additional information is identified by a String key.

Note: Methods that receive Augmentations are required to copy the information if it is to be saved for use beyond the scope of the method. The Augmentations content is volatile, and maybe modified by any method in any component in the pipeline. Therefore, methods passed this structure should not save any reference to the structure.

Author:
Elena Litani, IBM, Ronald Brill

  • Method Details

    • getBeginLineNumber

      int getBeginLineNumber()
      Returns:
      the line number of the beginning of this event.

    • getBeginColumnNumber

      int getBeginColumnNumber()
      Returns:
      the column number of the beginning of this event.

    • getBeginCharacterOffset

      int getBeginCharacterOffset()
      Returns:
      the character offset of the beginning of this event.

    • getEndLineNumber

      int getEndLineNumber()
      Returns:
      the line number of the end of this event.

    • getEndColumnNumber

      int getEndColumnNumber()
      Returns:
      the column number of the end of this event.

    • getEndCharacterOffset

      int getEndCharacterOffset()
      Returns:
      the character offset of the end of this event.

    • isSynthesized

      boolean isSynthesized()
      Returns:
      true if this corresponding event was synthesized.

    • clone

      Augmentations clone()
      Clones this Augmentation in case one has to keep the reference. The standard interface says, storing the original reference is not legal.
      Returns:
      a full copy of this augmentations holder