org.apache.fop.render

## Class AbstractRendererMaker

- java.lang.Object
- - org.apache.fop.render.AbstractRendererMaker

- Direct Known Subclasses:
    AWTRendererMaker, PNGRendererMaker, PrintRendererMaker, TIFFRendererMaker, TXTRendererMaker, XMLRendererMaker

      public abstract class AbstractRendererMaker
      extends Object

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

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `AbstractRendererMaker()`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | `configureRenderer(FOUserAgent userAgent, Renderer renderer)` Configures a given renderer using the appropriate configurator.
    `abstract String[]` | `getSupportedMimeTypes()`
    `boolean` | `isMimeTypeSupported(String mimeType)` Indicates whether a specific MIME type is supported by this renderer.
    `abstract Renderer` | `makeRenderer(FOUserAgent userAgent)` Instantiates a new renderer.
    `abstract boolean` | `needsOutputStream()`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### AbstractRendererMaker

          public AbstractRendererMaker()

  - ### Method Detail

    - #### makeRenderer

          public abstract Renderer makeRenderer(FOUserAgent userAgent)

      Instantiates a new renderer.
      Parameters:
        `userAgent` - the user agent
      Returns:
        the newly instantiated renderer

    - #### needsOutputStream

          public abstract boolean needsOutputStream()

      Returns:
        Indicates whether this renderer requires an OutputStream to work with.

    - #### getSupportedMimeTypes

          public abstract String[] getSupportedMimeTypes()

      Returns:
        an array of MIME types the renderer supports.

    - #### configureRenderer

          public abstract void configureRenderer(FOUserAgent userAgent,
                                                 Renderer renderer)
                                          throws FOPException

      Configures a given renderer using the appropriate configurator.
      Parameters:
        `userAgent` - user agent
        `renderer` - the renderer that is to be configured
      Throws:
        `FOPException`

    - #### isMimeTypeSupported

          public boolean isMimeTypeSupported(String mimeType)

      Indicates whether a specific MIME type is supported by this renderer.
      Parameters:
        `mimeType` - the MIME type (ex. "application/pdf")
      Returns:
        true if the MIME type is supported

Copyright © 2023 Apache Software Foundation. All rights reserved.