http://xmlgraphics.apache.org/fop/: Apache FOP (Formatting Objects Processor) is the world's first print formatter driven by XSL formatting objects (XSL-FO) and the world's first output independent formatter. It is a Java application that reads a formatting object (FO) tree and renders the resulting pages to a specified output. Output formats currently supported include PDF, PCL, PS, AFP, TIFF, PNG, SVG, XML (area tree representation), Print, AWT and TXT. The primary output target is PDF. (Apache Software Foundation) 
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* $Id: AbstractRendererMaker.java 1761020 2016-09-16 11:17:35Z ssteiner $ */

package org.apache.fop.render;

import org.apache.fop.apps.FOPException;
import org.apache.fop.apps.FOUserAgent;


Base class for factory classes which instantiate Renderers and provide information
about them.

/**
 * Base class for factory classes which instantiate Renderers and provide information
 * about them.
 */
public abstract class AbstractRendererMaker {

    
Instantiates a new renderer.

Params:
  • userAgent – the user agent
Returns:the newly instantiated renderer
/**
     * Instantiates a new renderer.
     * @param userAgent the user agent
     * @return the newly instantiated renderer
     */
    public abstract Renderer makeRenderer(FOUserAgent userAgent);

    
Returns:Indicates whether this renderer requires an OutputStream to work with.
/**
     * @return Indicates whether this renderer requires an OutputStream to work with.
     */
    public abstract boolean needsOutputStream();

    
Returns:an array of MIME types the renderer supports.
/**
     * @return an array of MIME types the renderer supports.
     */
    public abstract String[] getSupportedMimeTypes();

    
Configures a given renderer using the appropriate configurator.

Params:
  • userAgent – user agent
  • renderer – the renderer that is to be configured
/**
     * Configures a given renderer using the appropriate configurator.
     *
     * @param userAgent user agent
     * @param renderer the renderer that is to be configured
     */
    public abstract void configureRenderer(FOUserAgent userAgent, Renderer renderer)
            throws FOPException;

    
Indicates whether a specific MIME type is supported by this renderer.

Params:
  • mimeType – the MIME type (ex. "application/pdf")
Returns:true if the MIME type is supported
/**
     * Indicates whether a specific MIME type is supported by this renderer.
     * @param mimeType the MIME type (ex. "application/pdf")
     * @return true if the MIME type is supported
     */
    public boolean isMimeTypeSupported(String mimeType) {
        String[] mimes = getSupportedMimeTypes();
        for (String mime : mimes) {
            if (mime.equals(mimeType)) {
                return true;
            }
        }
        return false;
    }
}