jakarta.faces.event.PreRemoveFlashValueEvent 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;
import jakarta.faces.context.Flash;

/**
 *
 * 
 * This event must be published by a call to {@link jakarta.faces.application.Application#publishEvent} when a value is
 * removed from the flash.
 * 
 *
 * @since 2.2
 */
public class PreRemoveFlashValueEvent extends SystemEvent {

    private static final long serialVersionUID = -82999687346960430L;

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

    /**
     * 
     * Instantiate a new PreRemoveFlashValueEvent that indicates the argument key will be removed
     * from the flash. If the argument is null, the literal {@link Flash#NULL_VALUE} must be passed to the
     * superclass constructor.
     * 
     *
     * @param key the key in the flash that was just added.
     *
     */
    public PreRemoveFlashValueEvent(String key) {
        super(null == key ? Flash.NULL_VALUE : key);
    }

    /**
     * 
     * Instantiate a new PreRemoveFlashValueEvent that indicates the argument key will be removed
     * from the flash. If the argument is null, the literal {@link Flash#NULL_VALUE} must be passed to the
     * superclass constructor.
     * 
     *
     * @param facesContext the Faces context.
     * @param key the key in the flash that was just added.
     *
     */
    public PreRemoveFlashValueEvent(FacesContext facesContext, String key) {
        super(facesContext, key);
    }

    public String getKey() {
        return getSource().toString();
    }

}