Class PhaseId
- All Implemented Interfaces:
Comparable
public class PhaseId extends Object implements Comparable
Typesafe enumeration of the legal values that may be returned by the
getPhaseId()
method of the FacesEvent
interface.
-
Field Summary
Fields Modifier and Type Field Description static PhaseId
ANY_PHASE
Identifier that indicates an interest in events, no matter which request processing phase is being performed.static PhaseId
APPLY_REQUEST_VALUES
Identifier that indicates an interest in events queued for the Apply Request Values phase of the request processing lifecycle.static PhaseId
INVOKE_APPLICATION
Identifier that indicates an interest in events queued for the Invoke Application phase of the request processing lifecycle.static PhaseId
PROCESS_VALIDATIONS
Identifier that indicates an interest in events queued for the Process Validations phase of the request processing lifecycle.static PhaseId
RENDER_RESPONSE
Identifier for the Render Response phase of the request processing lifecycle.static PhaseId
RESTORE_VIEW
Identifier that indicates an interest in events queued for the Restore View phase of the request processing lifecycle.static PhaseId
UPDATE_MODEL_VALUES
Identifier that indicates an interest in events queued for the Update Model Values phase of the request processing lifecycle.static List<PhaseId>
VALUES
List of validPhaseId
instances, in ascending order of their ordinal value. -
Method Summary
Modifier and Type Method Description int
compareTo(Object other)
Compare thisPhaseId
instance to the specified one.String
getName()
Return the name of this phase.int
getOrdinal()
Return the ordinal value of thisPhaseId
instance.static PhaseId
phaseIdValueOf(String phase)
Return aPhaseId
representation of the arcumentphase
.String
toString()
Return a String representation of thisPhaseId
instance.
-
Field Details
-
ANY_PHASE
Identifier that indicates an interest in events, no matter which request processing phase is being performed.
-
RESTORE_VIEW
Identifier that indicates an interest in events queued for the Restore View phase of the request processing lifecycle.
-
APPLY_REQUEST_VALUES
Identifier that indicates an interest in events queued for the Apply Request Values 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.
-
UPDATE_MODEL_VALUES
Identifier that indicates an interest in events queued for the Update Model 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.
-
RENDER_RESPONSE
Identifier for the Render Response phase of the request processing lifecycle.
-
VALUES
List of valid
PhaseId
instances, in ascending order of their ordinal value.
-
-
Method Details
-
compareTo
Compare this
PhaseId
instance to the specified one. Returns a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object.- Specified by:
compareTo
in interfaceComparable
- Parameters:
other
- The other object to be compared to
-
getOrdinal
public int getOrdinal()Return the ordinal value of this
PhaseId
instance.- Returns:
- the ordinal
-
toString
Return a String representation of this
PhaseId
instance. -
getName
Return the name of this phase.
- Returns:
- the name
- Since:
- 2.2
-
phaseIdValueOf
Return a
PhaseId
representation of the arcumentphase
.- Parameters:
phase
- the String for which the correspondingPhaseId
should be returned.- Returns:
- the phase id corresponding to the argument
phase
- Throws:
NullPointerException
- if argumentphase
isnull
.FacesException
- if thePhaseId
corresponding to the argumentphase
cannot be found.- Since:
- 2.2
-