javax.faces.render.RenderKit Maven / Gradle / Ivy
/*
* $Id: RenderKit.java,v 1.35 2005/12/05 16:42:59 edburns Exp $
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://javaserverfaces.dev.java.net/CDDL.html or
* legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* [Name of File] [ver.__] [Date]
*
* Copyright 2005 Sun Microsystems Inc. All Rights Reserved
*/
package javax.faces.render;
import javax.faces.component.UIComponent;
import javax.faces.context.ResponseWriter;
import javax.faces.context.ResponseStream;
import java.io.Writer;
import java.io.OutputStream;
/**
* RenderKit represents a collection of
* {@link Renderer} instances that, together, know how to render
* JavaServer Faces {@link UIComponent} instances for a specific
* client. Typically, {@link RenderKit}s are specialized for
* some combination of client device type, markup language, and/or
* user Locale. A {@link RenderKit} also acts as
* a Factory for associated {@link Renderer} instances, which perform the
* actual rendering process for each component.
*
* A typical JavaServer Faces implementation will configure one or
* more {@link RenderKit} instances at web application startup. They
* are made available through calls to the getRenderKit()
* methods of {@link RenderKitFactory}. Because {@link RenderKit}
* instances are shared, they must be implemented in a thread-safe
* manner. Due to limitations in the current specification having
* multiple RenderKit instances at play in the same
* application requires a custom {@link
* javax.faces.application.ViewHandler} instance that is aware of how to
* deal with this case. This limitation will be lifted in a future
* version of the spec.
*
* The RenderKit instance must also vend a {@link
* ResponseStateManager} instance, which is used in the process of
* saving and restoring tree structure and state.
*/
// PENDING(edburns): remove limitation
public abstract class RenderKit {
/**
* Register the specified {@link Renderer} instance, associated with the
* specified component family and rendererType,
* to the set of {@link Renderer}s registered with this {@link RenderKit},
* replacing any previously registered {@link Renderer} for this
* combination of identifiers.
*
* @param family Component family of the {@link Renderer} to register
* @param rendererType Renderer type of the {@link Renderer} to register
* @param renderer {@link Renderer} instance we are registering
*
* @throws NullPointerException if family or
* rendererType or renderer is null
*/
public abstract void addRenderer(String family, String rendererType,
Renderer renderer);
/**
* Return the {@link Renderer} instance most recently registered for
* the specified component family and
* rendererType, if any; otherwise, return
* null.
*
* @param family Component family of the requested
* {@link Renderer} instance
* @param rendererType Renderer type of the requested
* {@link Renderer} instance
*
* @throws NullPointerException if family or
* rendererType is null
*/
public abstract Renderer getRenderer(String family, String rendererType);
/**
* Return an instance of {@link ResponseStateManager} to handle
* rendering technology specific state management decisions.
*/
public abstract ResponseStateManager getResponseStateManager();
/**
* Use the provided Writer to create a new {@link
* ResponseWriter} instance for the specified (optional) content
* type, and character encoding.
*
* Implementors are advised to consult the
* getCharacterEncoding() method of class {@link
* javax.servlet.ServletResponse} to get the required value for the
* characterEncoding for this method. Since the Writer
* for this response will already have been obtained (due to it
* ultimately being passed to this method), we know that the
* character encoding cannot change during the rendering of the
* response.
*
* @param writer the Writer around which this {@link ResponseWriter}
* must be built.
*
* @param contentTypeList an "Accept header style" list of content
* types for this response, or null if the RenderKit
* should choose the best fit. As of the current version, the
* values accepted by the Standard render-kit for this parameter
* include any valid "Accept header style" String that includes the
* String text/html,
* application/xhtml+xml, application/xml
* or text/xml. This may change in a future version.
* The RenderKit must support a value for this argument that comes
* straight from the Accept HTTP header, and therefore
* requires parsing according to the specification of the
* Accept header. Please see Section
* 14.1 of RFC 2616 for the specification of the
* Accept header.
*
* @param characterEncoding such as "ISO-8859-1" for this
* ResponseWriter, or null if the
* RenderKit should choose the best fit. Please see the
* IANA for a list of character encodings.
*
* @return a new {@link ResponseWriter}.
*
* @throws IllegalArgumentException if no matching content type
* can be found in contentTypeList, no appropriate
* content type can be found with the implementation dependent best
* fit algorithm, or no matching character encoding can be found for
* the argument characterEncoding.
*
*/
public abstract ResponseWriter createResponseWriter(Writer writer,
String contentTypeList,
String characterEncoding);
/**
* Use the provided OutputStream to create a new
* {@link ResponseStream} instance.
*
*/
public abstract ResponseStream createResponseStream(OutputStream out);
}