Enum Class VisitHint

java.lang.Object
java.lang.Enum<VisitHint>
jakarta.faces.component.visit.VisitHint
All Implemented Interfaces:
Serializable, Comparable<VisitHint>, Constable

public enum VisitHint extends Enum<VisitHint>

An enum that specifies hints that impact the behavior of a component tree visit.

Since:
2.0
  • Enum Constant Details

    • SKIP_UNRENDERED

      public static final VisitHint SKIP_UNRENDERED

      Hint that indicates that only the rendered subtrees should be visited.

      Since:
      2.0
    • SKIP_TRANSIENT

      public static final VisitHint SKIP_TRANSIENT

      Hint that indicates that only non-transient subtrees should be visited.

      Since:
      2.0
    • SKIP_ITERATION

      public static final VisitHint SKIP_ITERATION

      Hint that indicates that components that normally visit children multiple times (eg. UIData) in an iterative fashion should instead visit each child only one time.

      Since:
      2.1
    • EXECUTE_LIFECYCLE

      public static final VisitHint EXECUTE_LIFECYCLE

      Hint that indicates that the visit is being performed as part of lifecycle phase execution.

      Since:
      2.0
  • Method Details

    • values

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

      public static VisitHint valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null