Class PreClearFlashEvent

java.lang.Object

java.util.EventObject

jakarta.faces.event.SystemEvent

jakarta.faces.event.PreClearFlashEvent

All Implemented Interfaces:

Serializable

public class PreClearFlashEvent
extends SystemEvent

This event must be published by a call to Application.publishEvent(FacesContext, Class, Object) before the flash is cleared.

Since:

2.2

See Also:

• Serialized Form

Field Summary

Fields inherited from class EventObject

source

Constructor Summary

Constructors

Constructor	Description
PreClearFlashEvent(FacesContext facesContext, Map<String,Object> source)	Instantiate a new PreClearFlashEvent that indicates the argument key was just put to the flash.
PreClearFlashEvent(Map<String,Object> source)	Instantiate a new PreClearFlashEvent that indicates the argument key was just put to the flash.

Method Summary

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

PreClearFlashEvent

public PreClearFlashEvent(Map<String,Object> source)

Instantiate a new PreClearFlashEvent that indicates the argument key was just put to the flash.

Parameters:

source - Map containing the values about to be cleared This need not be the actual Flash instance.

Throws:

IllegalArgumentException - if the argument is null.

PreClearFlashEvent

public PreClearFlashEvent(FacesContext facesContext,
 Map<String,Object> source)

Instantiate a new PreClearFlashEvent that indicates the argument key was just put to the flash.

Parameters:

facesContext - the Faces context.

source - Map containing the values about to be cleared This need not be the actual Flash instance.

Throws:

IllegalArgumentException - if the argument is null.