jakarta.faces.event.PreDestroyCustomScopeEvent Maven / Gradle / Ivy

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.faces.event;

import jakarta.faces.context.FacesContext;

/**
 * 
 * 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 {@link PostConstructCustomScopeEvent} for a usage example, replacing classes as appropriate to make sense for this
 * class.
 * 
 *
 * @since 2.0
 */
public class PreDestroyCustomScopeEvent extends SystemEvent {

    // ------------------------------------------------------------ Constructors

    private static final long serialVersionUID = -3646173841788025206L;

    /**
     * 
     * An instance of this event indicates that the custom scope enclosed within the argument scopeContext is
     * about to end.
     * 
     *
     * @param scopeContext A structure that contains the name of the scope and the scope itself exposed as a
     * Map<String,
     * Object>.
     *
     */
    public PreDestroyCustomScopeEvent(ScopeContext scopeContext) {

        super(scopeContext);

    }

    /**
     * 
     * An instance of this event indicates that the custom scope enclosed within the argument scopeContext is
     * about to end.
     * 
     *
     * @param facesContext the Faces context.
     * @param scopeContext A structure that contains the name of the scope and the scope itself exposed as a
     * Map<String,
     * Object>.
     */
    public PreDestroyCustomScopeEvent(FacesContext facesContext, ScopeContext scopeContext) {
        super(facesContext, scopeContext);
    }

    // ---------------------------------------------------------- Public Methods

    /**
     * 
     * Return the ScopeContext for this event.
     * 
     *
     * @return the scope context.
     */
    public ScopeContext getContext() {

        return (ScopeContext) getSource();

    }

}