Class PreRemoveFlashValueEvent

java.lang.Object

java.util.EventObject

jakarta.faces.event.SystemEvent

jakarta.faces.event.PreRemoveFlashValueEvent

All Implemented Interfaces:

Serializable

public class PreRemoveFlashValueEvent
extends SystemEvent

This event must be published by a call to Application.publishEvent(FacesContext, Class, Object) when a value is removed from the flash.

Since:

2.2

See Also:

• Serialized Form

Field Summary

Fields inherited from class EventObject

source

Constructor Summary

Constructors

Constructor	Description
PreRemoveFlashValueEvent(FacesContext facesContext, String key)	Instantiate a new PreRemoveFlashValueEvent that indicates the argument key will be removed from the flash.
PreRemoveFlashValueEvent(String key)	Instantiate a new PreRemoveFlashValueEvent that indicates the argument key will be removed from the flash.

Method Summary

Modifier and Type	Method	Description
String	getKey()

Methods inherited from class SystemEvent

getFacesContext, isAppropriateListener, processListener

Modifier and Type	Method	Description
FacesContext	getFacesContext()	Get the Faces context.
boolean	isAppropriateListener(FacesListener listener)	Return true if this FacesListener is an instance of a the appropriate listener class that this event supports.
void	processListener(FacesListener listener)	Broadcast this event instance to the specified FacesListener, by whatever mechanism is appropriate.

Methods inherited from class EventObject

getSource, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

PreRemoveFlashValueEvent

public PreRemoveFlashValueEvent(String key)

Instantiate a new PreRemoveFlashValueEvent that indicates the argument key will be removed from the flash. If the argument is null, the literal Flash.NULL_VALUE must be passed to the superclass constructor.

Parameters:

key - the key in the flash that was just added.

PreRemoveFlashValueEvent

public PreRemoveFlashValueEvent(FacesContext facesContext,
 String key)

Instantiate a new PreRemoveFlashValueEvent that indicates the argument key will be removed from the flash. If the argument is null, the literal Flash.NULL_VALUE must be passed to the superclass constructor.

Parameters:

facesContext - the Faces context.

key - the key in the flash that was just added.

Method Details

getKey

public String getKey()