jakarta.faces.component.visit.VisitContextFactory Maven / Gradle / Ivy

Go to download
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
The 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.component.visit;

import java.util.Collection;
import java.util.Set;

import jakarta.faces.FacesWrapper;
import jakarta.faces.context.FacesContext;

/**
 * 
 * Provide for separation of interface and implementation for the
 * {@link VisitContext} contract.
 * 
 *
 * 
 * Usage: extend this class and push the implementation being wrapped to the constructor and use {@link #getWrapped} to
 * access the instance being wrapped.
 * 
 *
 * @since 2.0
 */
public abstract class VisitContextFactory implements FacesWrapper {

    private VisitContextFactory wrapped;

    /**
     * @deprecated Use the other constructor taking the implementation being wrapped.
     */
    @Deprecated
    public VisitContextFactory() {

    }

    /**
     * 
     * If this factory has been decorated, the implementation doing the decorating should push the implementation being
     * wrapped to this constructor. The {@link #getWrapped()} will then return the implementation being wrapped.
     * 
     *
     * @param wrapped The implementation being wrapped.
     */
    public VisitContextFactory(VisitContextFactory wrapped) {
        this.wrapped = wrapped;
    }

    /**
     * 
     * If this factory has been decorated, the implementation doing the decorating may override this method to provide
     * access to the implementation being wrapped.
     * 
     */
    @Override
    public VisitContextFactory getWrapped() {
        return wrapped;
    }

    /**
     * 
     * Return a new {@link VisitContext} instance.
     * 
     *
     * @param context the FacesContext for this request.
     * @param ids a Collection of clientIds to visit. If null all components will be visited.
     * @param hints the VisitHints that apply to this visit.
     *
     * @return the instance of VisitContext.
     *
     * @since 2.0
     */
    public abstract VisitContext getVisitContext(FacesContext context, Collection ids, Set hints);

}