Top Description Fields Constructors Methods
javax.faces.event

public Class PhaseId

extends Object
implements Comparable
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Imports
java.util.Arrays, .Collections, .List, javax.faces.FacesException

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

Field Summary

Modifier and TypeField and Description
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 String
ANY_PHASE_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 String
APPLY_REQUEST_VALUES_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 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 final int
ordinal

The ordinal value assigned to this instance.

private String
phaseName

The (optional) name for this phase.

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 String
PROCESS_VALIDATIONS_NAME

public static final PhaseId
RENDER_RESPONSE

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

private static final String
RENDER_RESPONSE_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 String
RESTORE_VIEW_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 String
UPDATE_MODEL_VALUES_NAME

private static final PhaseId[]
values

Array of all defined values, ascending order of ordinal value.

public static final List<PhaseId>
VALUES

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

Constructor Summary

AccessConstructor and Description
private
PhaseId(String newPhaseName)

Private constructor to disable the creation of new instances.

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(Object
The other object to be compared to
other)

Implements java.lang.Comparable.compareTo.

Compare this PhaseId instance to the specified one.

public String

Returns:

the name
getName()

Return the name of this phase.

public int

Returns:

the ordinal
getOrdinal()

Return the ordinal value of this PhaseId instance.

public static PhaseId

Returns:

the phase id corresponding to the argument phase
phaseIdValueOf(String
the String for which the corresponding PhaseId should be returned.
phase)

Return a PhaseId representation of the arcument phase.

public String
toString()

Overrides java.lang.Object.toString.

Return a String representation of this PhaseId instance.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

ANY_PHASEback to summary
public static final PhaseId ANY_PHASE

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

ANY_PHASE_NAMEback to summary
private static final String ANY_PHASE_NAME
APPLY_REQUEST_VALUESback to summary
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.

APPLY_REQUEST_VALUES_NAMEback to summary
private static final String APPLY_REQUEST_VALUES_NAME
INVOKE_APPLICATIONback to summary
public static final PhaseId INVOKE_APPLICATION

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

INVOKE_APPLICATION_NAMEback to summary
private static final String INVOKE_APPLICATION_NAME
nextOrdinalback to summary
private static int nextOrdinal

Static counter returning the ordinal value to be assigned to the next instance that is created.

ordinalback to summary
private final int ordinal

The ordinal value assigned to this instance.

phaseNameback to summary
private String phaseName

The (optional) name for this phase.

PROCESS_VALIDATIONSback to summary
public static final PhaseId PROCESS_VALIDATIONS

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

PROCESS_VALIDATIONS_NAMEback to summary
private static final String PROCESS_VALIDATIONS_NAME
RENDER_RESPONSEback to summary
public static final PhaseId RENDER_RESPONSE

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

RENDER_RESPONSE_NAMEback to summary
private static final String RENDER_RESPONSE_NAME
RESTORE_VIEWback to summary
public static final PhaseId RESTORE_VIEW

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

RESTORE_VIEW_NAMEback to summary
private static final String RESTORE_VIEW_NAME
UPDATE_MODEL_VALUESback to summary
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.

UPDATE_MODEL_VALUES_NAMEback to summary
private static final String UPDATE_MODEL_VALUES_NAME
valuesback to summary
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.

VALUESback to summary
public static final List<PhaseId> VALUES

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

Constructor Detail

PhaseIdback to summary
private PhaseId(String newPhaseName)

Private constructor to disable the creation of new instances.

Method Detail

compareToback to summary
public int compareTo(Object other)

Implements java.lang.Comparable.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.

Parameters
other:Object

The other object to be compared to

Returns:int

Doc from java.lang.Comparable.compareTo.

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
getNameback to summary
public String getName()

Return the name of this phase.

Returns:String

the name

Since
2.2
getOrdinalback to summary
public int getOrdinal()

Return the ordinal value of this PhaseId instance.

Returns:int

the ordinal

phaseIdValueOfback to summary
public static PhaseId phaseIdValueOf(String phase)

Return a PhaseId representation of the arcument phase.

Parameters
phase:String

the String for which the corresponding PhaseId should be returned.

Returns:PhaseId

the phase id corresponding to the argument phase

Exceptions
NullPointerException:
if argument phase is null.
FacesException:
if the PhaseId corresponding to the argument phase cannot be found.
Since
2.2
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Return a String representation of this PhaseId instance.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations
@Override