Enum SMInputCursor.Tracking

java.lang.Object
java.lang.Enum<SMInputCursor.Tracking>
org.codehaus.staxmate.in.SMInputCursor.Tracking
All Implemented Interfaces:
Serializable, Comparable<SMInputCursor.Tracking>, java.lang.constant.Constable
Enclosing class:
SMInputCursor

public static enum SMInputCursor.Tracking extends Enum<SMInputCursor.Tracking>
Different tracking behaviors available for cursors. Tracking is a feature that can be used to store information about traversed sub-trees, to allow for a limited access to information that is not limited to ancestor stack. Using tracking will consume more memory, but generally less than constructing a full in-memory tree object model (such as DOM), since it the represenation is compact, read-only, and only subset of a full tree. Size (and hence memory overhead) of that sub-tree depends on tracking settings.
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Value that indicates full element state information should be tracked for ALL elements (including ones not visible to the caller via SMInputCursor.getNext() method).
    Value that indicates that no element state information should be tracked.
    Value that indicates that element basic state information should be tracked, including linkage to the parent element (but only if the parent cursor was tracking elements).
    Value that indicates full element state information should be tracked for all "visible" elements: visible meaning that element node was accepted by the filter this cursor uses.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this type with the specified name.
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • NONE

      public static final SMInputCursor.Tracking NONE
      Value that indicates that no element state information should be tracked. This means that SMInputCursor.getTrackedElement() will always return null for this element, as well as that if immediate child cursors do have tracking enabled, element states it saves have no parent element information available.
    • PARENTS

      public static final SMInputCursor.Tracking PARENTS
      Value that indicates that element basic state information should be tracked, including linkage to the parent element (but only if the parent cursor was tracking elements). This means that SMInputCursor.getTrackedElement() will return non-null values, as soon as this cursor has been advanced over its first element node. However, element will return null from its SMElementInfo.getPreviousSibling() since sibling information is not tracked.
    • VISIBLE_SIBLINGS

      public static final SMInputCursor.Tracking VISIBLE_SIBLINGS
      Value that indicates full element state information should be tracked for all "visible" elements: visible meaning that element node was accepted by the filter this cursor uses. This means that SMInputCursor.getTrackedElement() will return non-null values, as soon as this cursor has been advanced over its first element node, and that element will return non-null from its SMElementInfo.getPreviousSibling() unless it's the first element iterated by this cursor.
    • ALL_SIBLINGS

      public static final SMInputCursor.Tracking ALL_SIBLINGS
      Value that indicates full element state information should be tracked for ALL elements (including ones not visible to the caller via SMInputCursor.getNext() method). This means that SMInputCursor.getTrackedElement() will return non-null values, as soon as this cursor has been advanced over its first element node, and that element will return non-null from its SMElementInfo.getPreviousSibling() unless it's the first element iterated by this cursor.
  • Constructor Details

    • Tracking

      private Tracking()
  • Method Details

    • values

      public static SMInputCursor.Tracking[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static SMInputCursor.Tracking valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null