jakarta.faces.view.facelets.FaceletCacheFactory 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, 2021 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.view.facelets;

import jakarta.faces.FacesWrapper;

/**
 * 
 * Allows customization of the implementation of {@link FaceletCache}.
 * 
 *
 * 
 * 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.1
 */
public abstract class FaceletCacheFactory implements FacesWrapper {

    private FaceletCacheFactory wrapped;

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

    }

    /**
     * 
     * 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 FaceletCacheFactory(FaceletCacheFactory 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 FaceletCacheFactory getWrapped() {
        return wrapped;
    }

    /**
     * Returns the facility by which the Facelets {@link jakarta.faces.view.ViewDeclarationLanguage} creates and
     * caches instances of Facelets.
     *
     * @return the facelet cache
     */
    public abstract FaceletCache getFaceletCache();

}