javax.faces.render.RenderKitFactory Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.render;
import java.util.Iterator;
import javax.faces.FacesWrapper;
import javax.faces.context.FacesContext;
/**
* RenderKitFactory is a
* factory object that registers
* and returns {@link RenderKit} instances. Implementations of
* JavaServer Faces must provide at least a default implementation of
* {@link RenderKit}. Advanced implementations (or external third party
* libraries) may provide additional {@link RenderKit} implementations
* (keyed by render kit identifiers) for performing different types of
* rendering for the same components.
*
* There must be one {@link RenderKitFactory} instance per web
* application that is utilizing JavaServer Faces. This instance can be
* acquired, in a portable manner, by calling:
*
* RenderKitFactory factory = (RenderKitFactory)
* FactoryFinder.getFactory(FactoryFinder.RENDER_KIT_FACTORY);
*
*
* Usage: extend this class and push the implementation being wrapped to the
* constructor and use {@link #getWrapped} to access the instance being wrapped.
*/
public abstract class RenderKitFactory implements FacesWrapper {
private RenderKitFactory wrapped;
/**
* @deprecated Use the other constructor taking the implementation being wrapped.
*/
@Deprecated
public RenderKitFactory() {
}
/**
* 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 RenderKitFactory(RenderKitFactory 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.
*
* @since 2.0
*/
@Override
public RenderKitFactory getWrapped() {
return wrapped;
}
/**
* The render kit identifier of the default {@link RenderKit} instance
* for this JavaServer Faces implementation.
*/
public static final String HTML_BASIC_RENDER_KIT = "HTML_BASIC";
/**
* Register the specified {@link RenderKit} instance, associated with
* the specified renderKitId, to be supported by this
* {@link RenderKitFactory}, replacing any previously registered
* {@link RenderKit} for this identifier.
*
* @param renderKitId Identifier of the {@link RenderKit} to register
* @param renderKit {@link RenderKit} instance that we are registering
*
* @throws NullPointerException if renderKitId or
* renderKit is null
*/
public abstract void addRenderKit(String renderKitId,
RenderKit renderKit);
/**
* Return a {@link RenderKit} instance for the specified render
* kit identifier, possibly customized based on dynamic
* characteristics of the specified {@link FacesContext}, if
* non-null. If there is no registered {@link
* RenderKit} for the specified identifier, return
* null. The set of available render kit identifiers
* is available via the getRenderKitIds() method.
*
* @param context FacesContext for the request currently being
* processed, or null if none is available.
* @param renderKitId Render kit identifier of the requested
* {@link RenderKit} instance
*
* @throws IllegalArgumentException if no {@link RenderKit} instance
* can be returned for the specified identifier
* @throws NullPointerException if renderKitId is
* null
*
* @return a {@link RenderKit} instance
*/
public abstract RenderKit getRenderKit(FacesContext context,
String renderKitId);
/**
* Return an Iterator over the set of render kit
* identifiers registered with this factory. This set must include
* the value specified by RenderKitFactory.HTML_BASIC_RENDER_KIT.
*
*
* @return an Iterator over the set of render kit identifiers
*/
public abstract Iterator getRenderKitIds();
}