jakarta.faces.event.PostConstructApplicationEvent 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.2

Show newest version

/*
 * 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.application.Application;
import jakarta.faces.context.FacesContext;

/**
 * 
 * This event must be published by the runtime after all configuration resources have been parsed and processed.
 * 
 *
 * 
 * This event is useful for listeners that need to perform custom post-configuration processing without having to rely
 * on ServletContextListeners which may be invoked before the Jakarta Faces runtime has started it's
 * configuration process.
 * 
 *
 * @since 2.0
 */
public class PostConstructApplicationEvent extends SystemEvent {

    private static final long serialVersionUID = -3918703770970591309L;

    /**
     * 
     * Constructs a new PostConstructApplicationEvent for this application.
     * 
     *
     * @param application the application that has been configured
     * @since 2.0
     */

    public PostConstructApplicationEvent(Application application) {
        super(application);
    }

    /**
     * 
     * Constructs a new PostConstructApplicationEvent for this application.
     * 
     *
     * @param facesContext the Faces context.
     * @param application the application that has been configured
     * @since 2.0
     */

    public PostConstructApplicationEvent(FacesContext facesContext, Application application) {
        super(facesContext, application);
    }

    /**
     * 
     * The source {@link Application} that sent this event.
     * 
     *
     * @return the application.
     * @since 2.0
     */

    public Application getApplication() {
        return (Application) getSource();
    }

}