javax.faces.component.visit.VisitContextWrapper 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, 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.component.visit;

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

import javax.faces.FacesWrapper;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;

/**
 * Provides
 * a simple implementation of
 * {@link VisitContext} that can be subclassed by developers wishing to
 * provide specialized behavior to an existing {@link VisitContext}
 * instance.  The default implementation of all methods is to call
 * through to the wrapped {@link VisitContext} instance.
 *
 * 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 VisitContextWrapper extends VisitContext implements FacesWrapper{

    private VisitContext wrapped;

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

    }

    /**
     * If this visit context 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.
     * @since 2.3
     */
    public VisitContextWrapper(VisitContext wrapped) {
        this.wrapped = wrapped;
    }

    @Override
    public VisitContext getWrapped() {
        return wrapped;
    }

    @Override
    public FacesContext getFacesContext() {
        return getWrapped().getFacesContext();
    }

    @Override
    public Set getHints() {
        return getWrapped().getHints();
    }

    @Override
    public Collection getIdsToVisit() {
        return getWrapped().getIdsToVisit();
    }

    @Override
    public Collection getSubtreeIdsToVisit(UIComponent component) {
        return getWrapped().getSubtreeIdsToVisit(component);
    }

    @Override
    public VisitResult invokeVisitCallback(UIComponent component, VisitCallback callback) {
        return getWrapped().invokeVisitCallback(component, callback);
    }

}