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

Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation

EE4J Compatible Implementation for Jakarta Faces API

There is a newer version: 4.1.1

/*
 * 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 java.util.Map;

import jakarta.faces.context.FacesContext;

/**
 *
 * 
 * This event must be published by a call to {@link jakarta.faces.application.Application#publishEvent} before the flash
 * is cleared.
 * 
 *
 * @since 2.2
 */
public class PreClearFlashEvent extends SystemEvent {

    private static final long serialVersionUID = -6069648757590884651L;

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

    /**
     * 
     * Instantiate a new PreClearFlashEvent that indicates the argument key was just put to the
     * flash.
     * 
     *
     * @param source Map containing the values about to be cleared This need not be the actual
     * {@link jakarta.faces.context.Flash} instance.
     *
     * @throws IllegalArgumentException if the argument is null.
     */
    public PreClearFlashEvent(Map source) {
        super(source);
    }

    /**
     * 
     * Instantiate a new PreClearFlashEvent that indicates the argument key was just put to the
     * flash.
     * 
     *
     * @param facesContext the Faces context.
     * @param source Map containing the values about to be cleared This need not be the actual
     * {@link jakarta.faces.context.Flash} instance.
     * @throws IllegalArgumentException if the argument is null.
     */
    public PreClearFlashEvent(FacesContext facesContext, Map source) {
        super(facesContext, source);
    }
}