public class PhaseId
extends java.lang.Object
implements java.lang.Comparable
Typesafe enumeration of the legal values that may be returned by the
getPhaseId()
method of the FacesEvent
interface.
Modifier and Type | Field and Description |
---|---|
static PhaseId |
ANY_PHASE
Identifier that indicates an interest in events, no matter
which request processing phase is being performed.
|
private static java.lang.String |
ANY_PHASE_NAME |
static PhaseId |
APPLY_REQUEST_VALUES
Identifier that indicates an interest in events queued for
the Apply Request Values phase of the request
processing lifecycle.
|
private static java.lang.String |
APPLY_REQUEST_VALUES_NAME |
static PhaseId |
INVOKE_APPLICATION
Identifier that indicates an interest in events queued for
the Invoke Application phase of the request
processing lifecycle.
|
private static java.lang.String |
INVOKE_APPLICATION_NAME |
private static int |
nextOrdinal
Static counter returning the ordinal value to be assigned to the
next instance that is created.
|
private int |
ordinal
The ordinal value assigned to this instance.
|
private java.lang.String |
phaseName
The (optional) name for this phase.
|
static PhaseId |
PROCESS_VALIDATIONS
Identifier that indicates an interest in events queued for
the Process Validations phase of the request
processing lifecycle.
|
private static java.lang.String |
PROCESS_VALIDATIONS_NAME |
static PhaseId |
RENDER_RESPONSE
Identifier for the Render Response phase of the
request processing lifecycle.
|
private static java.lang.String |
RENDER_RESPONSE_NAME |
static PhaseId |
RESTORE_VIEW
Identifier that indicates an interest in events queued for
the Restore View phase of the request
processing lifecycle.
|
private static java.lang.String |
RESTORE_VIEW_NAME |
static PhaseId |
UPDATE_MODEL_VALUES
Identifier that indicates an interest in events queued for
the Update Model Values phase of the request
processing lifecycle.
|
private static java.lang.String |
UPDATE_MODEL_VALUES_NAME |
private static PhaseId[] |
values
Array of all defined values, ascending order of ordinal value.
|
static java.util.List<PhaseId> |
VALUES
List of valid
PhaseId instances, in ascending order
of their ordinal value. |
Modifier | Constructor and Description |
---|---|
private |
PhaseId(java.lang.String newPhaseName)
Private constructor to disable the creation of new instances.
|
Modifier and Type | Method and Description |
---|---|
int |
compareTo(java.lang.Object other)
Compare this
PhaseId instance to the specified one. |
int |
getOrdinal()
Return the ordinal value of this
PhaseId instance. |
java.lang.String |
toString()
Return a String representation of this
PhaseId instance. |
private final int ordinal
The ordinal value assigned to this instance.
private java.lang.String phaseName
The (optional) name for this phase.
private static int nextOrdinal
Static counter returning the ordinal value to be assigned to the next instance that is created.
private static final java.lang.String ANY_PHASE_NAME
public static final PhaseId ANY_PHASE
Identifier that indicates an interest in events, no matter which request processing phase is being performed.
private static final java.lang.String RESTORE_VIEW_NAME
public static final PhaseId RESTORE_VIEW
Identifier that indicates an interest in events queued for the Restore View phase of the request processing lifecycle.
private static final java.lang.String APPLY_REQUEST_VALUES_NAME
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.
private static final java.lang.String PROCESS_VALIDATIONS_NAME
public static final PhaseId PROCESS_VALIDATIONS
Identifier that indicates an interest in events queued for the Process Validations phase of the request processing lifecycle.
private static final java.lang.String UPDATE_MODEL_VALUES_NAME
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.
private static final java.lang.String INVOKE_APPLICATION_NAME
public static final PhaseId INVOKE_APPLICATION
Identifier that indicates an interest in events queued for the Invoke Application phase of the request processing lifecycle.
private static final java.lang.String RENDER_RESPONSE_NAME
public static final PhaseId RENDER_RESPONSE
Identifier for the Render Response phase of the request processing lifecycle.
private static final PhaseId[] values
Array of all defined values, ascending order of ordinal value. Be sure you include any new instances created above, in the same order.
private PhaseId(java.lang.String newPhaseName)
Private constructor to disable the creation of new instances.
public int compareTo(java.lang.Object other)
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.
compareTo
in interface java.lang.Comparable
other
- The other object to be compared topublic int getOrdinal()
Return the ordinal value of this PhaseId
instance.
public java.lang.String toString()
Return a String representation of this PhaseId
instance.
toString
in class java.lang.Object