Module org.htmlunit.cyberneko
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 may be 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 Summary

    Modifier and Type
    Method
    Description
    Augmentations
    clone()
    Clones this Augmentations instance in case a reference needs to be retained.
    int
    getBeginCharacterOffset()
    Returns the character offset of the beginning of this event.
    int
    getBeginColumnNumber()
    Returns the column number of the beginning of this event.
    int
    getBeginLineNumber()
    Returns the line number of the beginning of this event.
    int
    getEndCharacterOffset()
    Returns the character offset of the end of this event.
    int
    getEndColumnNumber()
    Returns the column number of the end of this event.
    int
    getEndLineNumber()
    Returns the line number of the end of this event.
    boolean
    isSynthesized()
    Returns whether the corresponding event was synthesized.

  • Method Details

    • getBeginLineNumber

      int getBeginLineNumber()
      Returns the line number of the beginning of this event.
      Returns:
      the one-based begin line number, or -1 if not available

    • getBeginColumnNumber

      int getBeginColumnNumber()
      Returns the column number of the beginning of this event.
      Returns:
      the one-based begin column number, or -1 if not available

    • getBeginCharacterOffset

      int getBeginCharacterOffset()
      Returns the character offset of the beginning of this event.
      Returns:
      the zero-based begin character offset, or -1 if not available

    • getEndLineNumber

      int getEndLineNumber()
      Returns the line number of the end of this event.
      Returns:
      the one-based end line number, or -1 if not available

    • getEndColumnNumber

      int getEndColumnNumber()
      Returns the column number of the end of this event.
      Returns:
      the one-based end column number, or -1 if not available

    • getEndCharacterOffset

      int getEndCharacterOffset()
      Returns the character offset of the end of this event.
      Returns:
      the zero-based end character offset, or -1 if not available

    • isSynthesized

      boolean isSynthesized()
      Returns whether the corresponding event was synthesized.
      Returns:
      true if the event was synthesized, false otherwise

    • clone

      Augmentations clone()
      Clones this Augmentations instance in case a reference needs to be retained. Storing the original reference directly is illegal due to its volatile nature.
      Returns:
      a full copy of this augmentations holder