jakarta.faces.flow.FlowHandlerFactory 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.flow;

import jakarta.faces.context.FacesContext;

/**
 * 
 * FlowHandlerFactory is used by the {@link jakarta.faces.application.Application} to create the
 * singleton instance of {@link FlowHandler}.
 * 
 *
 * @since 2.2
 */
public abstract class FlowHandlerFactory {

    public FlowHandlerFactory() {
    }

    /**
     * 
     * Create the singleton instance of {@link FlowHandler}.
     * 
     *
     * @param context the {@link FacesContext} for the current request
     *
     * @return the newly created {@link FlowHandler}
     *
     * @since 2.2
     */
    public abstract FlowHandler createFlowHandler(FacesContext context);

}