javax.faces.component

Class UIComponent.ComponentSystemEventListenerAdapter

java.lang.Object

javax.faces.component.UIComponent.ComponentSystemEventListenerAdapter

All Implemented Interfaces:

java.util.EventListener, StateHolder, FacesListener, SystemEventListener, FacesWrapper<ComponentSystemEventListener>

Enclosing class:

UIComponent

static final class UIComponent.ComponentSystemEventListenerAdapter
extends java.lang.Object
implements SystemEventListener, StateHolder, FacesWrapper<ComponentSystemEventListener>

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.Class<?>	instanceClass
(package private) ComponentSystemEventListener	wrapped

Constructor Summary

Constructors

Constructor and Description
ComponentSystemEventListenerAdapter()
ComponentSystemEventListenerAdapter(ComponentSystemEventListener wrapped, UIComponent component)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
ComponentSystemEventListener	getWrapped() A class that implements this interface uses this method to return an instance of the class being wrapped.
int	hashCode()
boolean	isListenerForSource(java.lang.Object component) This method must return true if and only if this listener instance is interested in receiving events from the instance referenced by the source parameter.
boolean	isTransient() If true, the Object implementing this interface must not participate in state saving or restoring.
void	processEvent(SystemEvent event) When called, the listener can assume that any guarantees given in the javadoc for the specific SystemEvent subclass are true.
void	restoreState(FacesContext context, java.lang.Object state) Perform any processing required to restore the state from the entries in the state Object.
java.lang.Object	saveState(FacesContext context) Gets the state of the instance as a Serializable Object.
void	setTransient(boolean newTransientValue) Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

wrapped

ComponentSystemEventListener wrapped

instanceClass

java.lang.Class<?> instanceClass

Constructor Detail

ComponentSystemEventListenerAdapter

ComponentSystemEventListenerAdapter()

ComponentSystemEventListenerAdapter

ComponentSystemEventListenerAdapter(ComponentSystemEventListener wrapped,
                                    UIComponent component)

Method Detail

processEvent

public void processEvent(SystemEvent event)
                  throws AbortProcessingException

Description copied from interface: SystemEventListener

When called, the listener can assume that any guarantees given in the javadoc for the specific SystemEvent subclass are true.

Specified by:

processEvent in interface SystemEventListener

Parameters:

event - the SystemEvent instance that is being processed.

Throws:

AbortProcessingException - if lifecycle processing should cease for this request.

isListenerForSource

public boolean isListenerForSource(java.lang.Object component)

Description copied from interface: SystemEventListener

This method must return true if and only if this listener instance is interested in receiving events from the instance referenced by the source parameter.

Specified by:

isListenerForSource in interface SystemEventListener

Parameters:

component - the source that is inquiring about the appropriateness of sending an event to this listener instance.

saveState

public java.lang.Object saveState(FacesContext context)

Description copied from interface: StateHolder

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.saveState(javax.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets. That is done via the StateManager

This method must not alter the state of the implementing object. In other words, after executing this code:

 Object state = component.saveState(facesContext);
 

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:

saveState in interface StateHolder

restoreState

public void restoreState(FacesContext context,
                         java.lang.Object state)

Description copied from interface: StateHolder

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

If the state argument is null, take no action and return.

Specified by:

restoreState in interface StateHolder

isTransient

public boolean isTransient()

Description copied from interface: StateHolder

If true, the Object implementing this interface must not participate in state saving or restoring.

Specified by:

isTransient in interface StateHolder

setTransient

public void setTransient(boolean newTransientValue)

Description copied from interface: StateHolder

Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

Specified by:

setTransient in interface StateHolder

Parameters:

newTransientValue - boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.

getWrapped

public ComponentSystemEventListener getWrapped()

Description copied from interface: FacesWrapper

A class that implements this interface uses this method to return an instance of the class being wrapped.

Specified by:

getWrapped in interface FacesWrapper<ComponentSystemEventListener>

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object