Module jakarta.faces

Package jakarta.faces.event

Class PreDestroyCustomScopeEvent

java.lang.Object

java.util.EventObject

jakarta.faces.event.SystemEvent

jakarta.faces.event.PreDestroyCustomScopeEvent

All Implemented Interfaces:

Serializable

@Deprecated(since="4.1",
            forRemoval=true)
public class PreDestroyCustomScopeEvent
extends SystemEvent

Deprecated, for removal: This API element is subject to removal in a future version.

because CustomScope has been removed from Faces in favor of CDI.

This class is provided to allow custom scopes to publish a "pre construct" event in the same way that other scopes do to let the application become aware of the beginning of the scope. The runtime must listen for this event and invoke any PreDestroy annotated methods on any of the beans in this scope as appropriate. See the example code on PostConstructCustomScopeEvent for a usage example, replacing classes as appropriate to make sense for this class.

Since:

2.0

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
PreDestroyCustomScopeEvent(FacesContext facesContext, ScopeContext scopeContext)	Deprecated, for removal: This API element is subject to removal in a future version. An instance of this event indicates that the custom scope enclosed within the argument scopeContext is about to end.
PreDestroyCustomScopeEvent(ScopeContext scopeContext)	Deprecated, for removal: This API element is subject to removal in a future version. An instance of this event indicates that the custom scope enclosed within the argument scopeContext is about to end.

Method Summary

Modifier and Type	Method	Description
ScopeContext	getContext()	Deprecated, for removal: This API element is subject to removal in a future version. Return the ScopeContext for this event.

Methods inherited from class jakarta.faces.event.SystemEvent

getFacesContext, isAppropriateListener, processListener

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Details

PreDestroyCustomScopeEvent

public PreDestroyCustomScopeEvent(ScopeContext scopeContext)

Deprecated, for removal: This API element is subject to removal in a future version.

An instance of this event indicates that the custom scope enclosed within the argument scopeContext is about to end.

Parameters:

scopeContext - A structure that contains the name of the scope and the scope itself exposed as a Map<String, Object>.

PreDestroyCustomScopeEvent

public PreDestroyCustomScopeEvent(FacesContext facesContext,
 ScopeContext scopeContext)

Deprecated, for removal: This API element is subject to removal in a future version.

An instance of this event indicates that the custom scope enclosed within the argument scopeContext is about to end.

Parameters:

facesContext - the Faces context.

scopeContext - A structure that contains the name of the scope and the scope itself exposed as a Map<String, Object>.

Method Details

getContext

public ScopeContext getContext()

Deprecated, for removal: This API element is subject to removal in a future version.

Return the ScopeContext for this event.

Returns:

the scope context.