javax.faces.view.ViewDeclarationLanguageFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jboss-jsf-api_2.3_spec Show documentation
JSR-000372: JavaServer(TM) Faces 2.3 API
There is a newer version: 3.1.0.SP02
Show newest version
/*
 * 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.view;

import static java.util.Collections.emptyList;

import java.util.List;

import javax.faces.FacesWrapper;

/**
 * ViewDeclarationLanguageFactory
 * is a factory object that creates (if needed) and returns a new {@link
 * ViewDeclarationLanguage} instance based on the VDL found in a
 * specific view.
 *
 * 
 *
 * There must be one ViewDeclarationLanguageFactory instance per web
 * application that is utilizing Jakarta Server Faces.  This instance can be
 * acquired, in a portable manner, by calling:
 *
 * 
 *   ViewDeclarationLanguageFactory factory = (ViewDeclarationLanguageFactory)
 *    FactoryFinder.getFactory(FactoryFinder.VIEW_DECLARATION_LANGUAGE_FACTORY);
 * 
 *

 * 
 *
 * 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 ViewDeclarationLanguageFactory implements FacesWrapper {

    private ViewDeclarationLanguageFactory wrapped;

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

    }

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


    /**
     * Return the
     * ViewDeclarationLanguage instance suitable for
     * handling the VDL contained in the page referenced by the argument
     * viewId.  The default implementation must return a
     * valid ViewDeclarationLanguage instance for views
     * written in either Jakarta Server Pages, Faces XML Views, or Facelets for 
     * Jakarta Server Faces 2.
     *
     * @param viewId the viewId to be inspected for an appropriate
     * ViewDeclarationLanguage implementation for the VDL used
     * in the view.
     *
     * @since 2.0
     *
     * @throws NullPointerException if viewId is null.
     *
     * @return the {@code ViewDeclarationLanguage} corresponding to the
     * argument {@code viewId}
     *
     */
    public abstract ViewDeclarationLanguage getViewDeclarationLanguage(String viewId);

    public List getAllViewDeclarationLanguages() {
        return emptyList();
    }

}