javax.faces.event.PreDestroyViewMapEvent Maven / Gradle / Ivy

Go to download

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

Jakarta Faces defines an MVC framework for building user interfaces for web applications, including UI components, state management, event handing, input validation, page navigation, and support for internationalization and accessibility.

There is a newer version: 4.1.0

Show newest version

/*
 * Copyright (c) 1997, 2018 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 javax.faces.event;

import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;

/**
 *
 * This event must be published by a call
 * to {@link javax.faces.application.Application#publishEvent} when the
 * clear method is called on the map returned from {@link
 * UIViewRoot#getViewMap}.
 *
 * @since 2.0
 */
public class PreDestroyViewMapEvent extends ComponentSystemEvent {

    private static final long serialVersionUID = 4470489935758914483L;


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


    /**
     * 
Instantiate a new
     * ViewMapDestroydEvent that indicates the argument
     * root just had its associated view map destroyed.

     * @param root the UIViewRoot for which the view map has
     * just been destroyed.
     *
     * @throws IllegalArgumentException if the argument is null.
     */
    public PreDestroyViewMapEvent(UIViewRoot root) {
        super(root);
    }
    
    /**
     * Instantiate a new
     * ViewMapDestroydEvent that indicates the argument
     * root just had its associated view map destroyed.
     * 
     * @param facesContext the Faces context.
     * @param root the UIViewRoot for which the view map has
     * just been destroyed.
     * @throws IllegalArgumentException if the argument is null.
     */
    public PreDestroyViewMapEvent(FacesContext facesContext, UIViewRoot root) {
        super(facesContext, root);
    }

}