Enum Class PhaseId

java.lang.Object
java.lang.Enum<PhaseId>
jakarta.faces.event.PhaseId
All Implemented Interfaces:
Serializable, Comparable<PhaseId>, Constable
public enum PhaseId extends Enum<PhaseId>

Enum of the legal values that may be returned by the getPhaseId() method of the FacesEvent interface.

  • Nested Class Summary

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ANY_PHASE
    Identifier that indicates an interest in events, no matter which request processing phase is being performed.
    APPLY_REQUEST_VALUES
    Identifier that indicates an interest in events queued for the Apply Request Values phase of the request processing lifecycle.
    INVOKE_APPLICATION
    Identifier that indicates an interest in events queued for the Invoke Application phase of the request processing lifecycle.
    PROCESS_VALIDATIONS
    Identifier that indicates an interest in events queued for the Process Validations phase of the request processing lifecycle.
    RENDER_RESPONSE
    Identifier for the Render Response phase of the request processing lifecycle.
    RESTORE_VIEW
    Identifier that indicates an interest in events queued for the Restore View phase of the request processing lifecycle.
    UPDATE_MODEL_VALUES
    Identifier that indicates an interest in events queued for the Update Model Values phase of the request processing lifecycle.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final List<PhaseId>
    VALUES
    List of valid PhaseId instances, in ascending order of their ordinal value.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Return the name of this phase.
    int
    getOrdinal()
    Return the ordinal value of this PhaseId instance.
    static PhaseId
    phaseIdValueOf(String phase)
    Return a PhaseId representation of the argument phase.
    String
    toString()
    Return a String representation of this PhaseId instance.
    static PhaseId
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static PhaseId[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ANY_PHASE

      public static final PhaseId ANY_PHASE

      Identifier that indicates an interest in events, no matter which request processing phase is being performed.

    • RESTORE_VIEW

      public static final PhaseId RESTORE_VIEW

      Identifier that indicates an interest in events queued for the Restore View phase of the request processing lifecycle.

    • APPLY_REQUEST_VALUES

      public static final PhaseId APPLY_REQUEST_VALUES

      Identifier that indicates an interest in events queued for the Apply Request Values phase of the request processing lifecycle.

    • PROCESS_VALIDATIONS

      public static final PhaseId PROCESS_VALIDATIONS

      Identifier that indicates an interest in events queued for the Process Validations phase of the request processing lifecycle.

    • UPDATE_MODEL_VALUES

      public static final PhaseId UPDATE_MODEL_VALUES

      Identifier that indicates an interest in events queued for the Update Model Values phase of the request processing lifecycle.

    • INVOKE_APPLICATION

      public static final PhaseId INVOKE_APPLICATION

      Identifier that indicates an interest in events queued for the Invoke Application phase of the request processing lifecycle.

    • RENDER_RESPONSE

      public static final PhaseId RENDER_RESPONSE

      Identifier for the Render Response phase of the request processing lifecycle.

  • Field Details

    • VALUES

      public static final List<PhaseId> VALUES

      List of valid PhaseId instances, in ascending order of their ordinal value.

  • Method Details

    • values

      public static PhaseId[] 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 PhaseId 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

    • getOrdinal

      public int getOrdinal()

      Return the ordinal value of this PhaseId instance.

      Returns:
      the ordinal

    • toString

      public String toString()

      Return a String representation of this PhaseId instance.

      Overrides:
      toString in class Enum<PhaseId>

    • getName

      public String getName()

      Return the name of this phase.

      Returns:
      the name
      Since:
      2.2

    • phaseIdValueOf

      public static PhaseId phaseIdValueOf(String phase)

      Return a PhaseId representation of the argument phase.

      Parameters:
      phase - the String for which the corresponding PhaseId should be returned.
      Returns:
      the phase id corresponding to the argument phase
      Throws:
      NullPointerException - if argument phase is null.
      FacesException - if the PhaseId corresponding to the argument phase cannot be found.
      Since:
      2.2