javax.faces.context.PartialViewContextFactory Maven / Gradle / Ivy
Show all versions of jakarta.faces Show documentation
/*
* 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.context;
import javax.faces.FacesWrapper;
/**
* PartialViewContextFactory is a
* factory object that creates (if needed) and returns new {@link
* PartialViewContext} instances.
*
*
*
* There must be one PartialViewContextFactory instance per web
* application that is utilizing Jakarta Server Faces. This instance can be
* acquired, in a portable manner, by calling:
*
* PartialViewContextFactory factory = (PartialViewContextFactory)
* FactoryFinder.getFactory(FactoryFinder.PARTIAL_VIEW_CONTEXT_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 PartialViewContextFactory implements FacesWrapper {
private PartialViewContextFactory wrapped;
/**
* @deprecated Use the other constructor taking the implementation being wrapped.
*/
@Deprecated
public PartialViewContextFactory() {
}
/**
* 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 PartialViewContextFactory(PartialViewContextFactory 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 PartialViewContextFactory getWrapped() {
return wrapped;
}
// ---------------------------------------------------------- Public Methods
/**
* Create (if needed)
* and return a {@link PartialViewContext} instance that is initialized
* using the current {@link FacesContext} instance.
*
* @param context the {@link FacesContext} for the current request.
*
* @return the {@link PartialViewContext} as specified above
*/
public abstract PartialViewContext getPartialViewContext(FacesContext context);
}