## Uses of Class
org.apache.xmlgraphics.image.loader.ImageFlavor

- Packages that use ImageFlavor
  Package | Description
  --- | ---
  org.apache.xmlgraphics.image.loader | Contains image loading and conversion infrastructure for various image sources and an image cache.
  org.apache.xmlgraphics.image.loader.cache | Contains image caching infrastructure.
  org.apache.xmlgraphics.image.loader.impl | Contains implementations of image loaders and converters.
  org.apache.xmlgraphics.image.loader.impl.imageio | Contains an implementation of an image loader which uses ImageIO.
  org.apache.xmlgraphics.image.loader.pipeline | Provides an image loading and processing pipeline.
  org.apache.xmlgraphics.image.loader.spi | Defines service provider interfaces for the image infrastructure.

- - ### Uses of ImageFlavor in org.apache.xmlgraphics.image.loader

    Subclasses of ImageFlavor in org.apache.xmlgraphics.image.loader
    Modifier and Type | Class and Description
    --- | ---
    `class` | `MimeEnabledImageFlavor` Special image flavor subclass which enables the restriction to a particular MIME type.
    `class` | `RefinedImageFlavor` Special image flavor subclass which enables the refinement to specific (sub-)flavors but maintaining compatibility to a parent (i.e.
    `class` | `SimpleRefinedImageFlavor` Simple refined image flavor implementation that just differs flavors by name but allows to specify a parent flavor.
    `class` | `XMLNamespaceEnabledImageFlavor` Special image flavor subclass which enables the restriction to a particular XML namespace.

    Fields in org.apache.xmlgraphics.image.loader declared as ImageFlavor
    Modifier and Type | Field and Description
    --- | ---
    `static ImageFlavor` | ImageFlavor.`BUFFERED_IMAGE` An image in form of a BufferedImage instance
    `static ImageFlavor` | ImageFlavor.`GRAPHICS2D` An image in form of a Graphics2DImage (can be painted on a Graphics2D interface)
    `static ImageFlavor` | ImageFlavor.`RAW` An image in form of a raw PNG file/stream
    `static ImageFlavor` | ImageFlavor.`RAW_CCITTFAX` An image in form of a raw CCITTFax stream
    `static ImageFlavor` | ImageFlavor.`RAW_EMF` An image in form of a raw EMF (Windows Enhanced Metafile) file/stream
    `static ImageFlavor` | ImageFlavor.`RAW_EPS` An image in form of a raw EPS (Encapsulated PostScript) file/stream
    `static ImageFlavor` | ImageFlavor.`RAW_JPEG` An image in form of a raw JPEG/JFIF file/stream
    `static ImageFlavor` | ImageFlavor.`RAW_LZW` An image in form of a raw LZW file/stream
    `static ImageFlavor` | ImageFlavor.`RAW_PNG` An image in form of a raw PNG file/stream
    `static ImageFlavor` | ImageFlavor.`RAW_TIFF` An image in form of a raw TIFF file/stream
    `static ImageFlavor` | ImageFlavor.`RENDERED_IMAGE` An image in form of a RenderedImage instance
    `static ImageFlavor` | XMLNamespaceEnabledImageFlavor.`SVG_DOM` An XML-based SVG image in form of a W3C DOM instance
    `static ImageFlavor` | ImageFlavor.`XML_DOM` An XML-based image in form of a W3C DOM instance

    Methods in org.apache.xmlgraphics.image.loader that return ImageFlavor
    Modifier and Type | Method and Description
    --- | ---
    `ImageFlavor` | Image.`getFlavor()` Returns the flavor of the image.
    `ImageFlavor` | RefinedImageFlavor.`getParentFlavor()` Returns the associated parent image flavor.

    Methods in org.apache.xmlgraphics.image.loader with parameters of type ImageFlavor
    Modifier and Type | Method and Description
    --- | ---
    `Image` | ImageManager.`convertImage(Image image, ImageFlavor[] flavors)` Converts an image with no hints.
    `Image` | ImageManager.`convertImage(Image image, ImageFlavor[] flavors, java.util.Map hints)` Converts an image.
    `Image` | ImageManager.`getImage(ImageInfo info, ImageFlavor[] flavors, ImageSessionContext session)` Loads an image with no hints.
    `Image` | ImageManager.`getImage(ImageInfo info, ImageFlavor[] flavors, java.util.Map hints, ImageSessionContext session)` Loads an image.
    `Image` | ImageManager.`getImage(ImageInfo info, ImageFlavor flavor, ImageSessionContext session)` Loads an image with no hints.
    `Image` | ImageManager.`getImage(ImageInfo info, ImageFlavor flavor, java.util.Map hints, ImageSessionContext session)` Loads an image.
    `boolean` | RefinedImageFlavor.`isCompatible(ImageFlavor flavor)` Indicates whether a particular image flavor is compatible with this one.
    `boolean` | ImageFlavor.`isCompatible(ImageFlavor flavor)` Indicates whether a particular image flavor is compatible with this one.

    Constructors in org.apache.xmlgraphics.image.loader with parameters of type ImageFlavor
    Constructor and Description
    `MimeEnabledImageFlavor(ImageFlavor parentFlavor, java.lang.String mime)` Constructs a new image flavor.
    `RefinedImageFlavor(ImageFlavor parentFlavor)` Constructs a new image flavor.
    `RefinedImageFlavor(java.lang.String name, ImageFlavor parentFlavor)` Constructs a new image flavor.
    `SimpleRefinedImageFlavor(ImageFlavor parentFlavor, java.lang.String name)` Main constructor.
    `XMLNamespaceEnabledImageFlavor(ImageFlavor parentFlavor, java.lang.String namespace)` Constructs a new image flavor.

  - ### Uses of ImageFlavor in org.apache.xmlgraphics.image.loader.cache

    Methods in org.apache.xmlgraphics.image.loader.cache with parameters of type ImageFlavor
    Modifier and Type | Method and Description
    --- | ---
    `Image` | ImageCache.`getImage(ImageInfo info, ImageFlavor flavor)` Returns an image from the cache or null if it wasn't found.
    `Image` | ImageCache.`getImage(java.lang.String uri, ImageFlavor flavor)` Returns an image from the cache or null if it wasn't found.

    Constructors in org.apache.xmlgraphics.image.loader.cache with parameters of type ImageFlavor
    Constructor and Description
    `ImageKey(java.lang.String uri, ImageFlavor flavor)` Main constructor.

  - ### Uses of ImageFlavor in org.apache.xmlgraphics.image.loader.impl

    Methods in org.apache.xmlgraphics.image.loader.impl that return ImageFlavor
    Modifier and Type | Method and Description
    --- | ---
    `ImageFlavor` | ImageRendered.`getFlavor()` Returns the flavor of the image.
    `ImageFlavor` | ImageBuffered.`getFlavor()` Returns the flavor of the image.
    `ImageFlavor` | ImageGraphics2D.`getFlavor()` Returns the flavor of the image.
    `ImageFlavor` | ImageRawStream.`getFlavor()` Returns the flavor of the image.
    `ImageFlavor` | ImageXMLDOM.`getFlavor()` Returns the flavor of the image.
    `ImageFlavor` | ImageConverterRendered2PNG.`getSourceFlavor()` Returns the flavor that this converter expects.
    `ImageFlavor` | ImageConverterBitmap2G2D.`getSourceFlavor()` Returns the flavor that this converter expects.
    `ImageFlavor` | ImageConverterBuffered2Rendered.`getSourceFlavor()` Returns the flavor that this converter expects.
    `ImageFlavor` | ImageConverterG2D2Bitmap.`getSourceFlavor()` Returns the flavor that this converter expects.
    `ImageFlavor[]` | ImageLoaderFactoryEPS.`getSupportedFlavors(java.lang.String mime)` Returns an array of ImageFlavors that are supported by this implementation for a given MIME type.
    `ImageFlavor[]` | ImageLoaderFactoryRawCCITTFax.`getSupportedFlavors(java.lang.String mime)` Returns an array of ImageFlavors that are supported by this implementation for a given MIME type.
    `ImageFlavor[]` | ImageLoaderFactoryPNG.`getSupportedFlavors(java.lang.String mime)` Returns an array of ImageFlavors that are supported by this implementation for a given MIME type.
    `ImageFlavor[]` | ImageLoaderFactoryInternalTIFF.`getSupportedFlavors(java.lang.String mime)` Returns an array of ImageFlavors that are supported by this implementation for a given MIME type.
    `ImageFlavor[]` | ImageLoaderFactoryRaw.`getSupportedFlavors(java.lang.String mime)` Returns an array of ImageFlavors that are supported by this implementation for a given MIME type.
    `ImageFlavor` | ImageConverterRendered2PNG.`getTargetFlavor()` Returns the flavor that this converter converts images into.
    `ImageFlavor` | ImageLoaderRawCCITTFax.`getTargetFlavor()` Returns the image flavor that is returned by this ImageLoader implementation.
    `ImageFlavor` | ImageLoaderRawPNG.`getTargetFlavor()` Returns the image flavor that is returned by this ImageLoader implementation.
    `ImageFlavor` | CompositeImageLoader.`getTargetFlavor()` Returns the image flavor that is returned by this ImageLoader implementation.
    `ImageFlavor` | ImageLoaderRawJPEG.`getTargetFlavor()` Returns the image flavor that is returned by this ImageLoader implementation.
    `ImageFlavor` | ImageLoaderRaw.`getTargetFlavor()` Returns the image flavor that is returned by this ImageLoader implementation.
    `ImageFlavor` | ImageLoaderPNG.`getTargetFlavor()` Returns the image flavor that is returned by this ImageLoader implementation.
    `ImageFlavor` | ImageConverterBitmap2G2D.`getTargetFlavor()` Returns the flavor that this converter converts images into.
    `ImageFlavor` | ImageLoaderInternalTIFF.`getTargetFlavor()` Returns the image flavor that is returned by this ImageLoader implementation.
    `ImageFlavor` | ImageConverterBuffered2Rendered.`getTargetFlavor()` Returns the flavor that this converter converts images into.
    `ImageFlavor` | ImageConverterG2D2Bitmap.`getTargetFlavor()` Returns the flavor that this converter converts images into.
    `ImageFlavor` | ImageLoaderEPS.`getTargetFlavor()` Returns the image flavor that is returned by this ImageLoader implementation.

    Methods in org.apache.xmlgraphics.image.loader.impl with parameters of type ImageFlavor
    Modifier and Type | Method and Description
    --- | ---
    `static java.lang.String` | ImageLoaderFactoryRawCCITTFax.`getMimeForRawFlavor(ImageFlavor flavor)` Returns the MIME type for a given ImageFlavor if it is from a format that is consumed without being undecoded.
    `static java.lang.String` | ImageLoaderFactoryRaw.`getMimeForRawFlavor(ImageFlavor flavor)` Returns the MIME type for a given ImageFlavor if it is from a format that is consumed without being undecoded.
    `int` | AbstractImageLoaderFactory.`getUsagePenalty(java.lang.String mime, ImageFlavor flavor)` Deprecated. Redundancy with `ImageLoader.getUsagePenalty()`
    `ImageLoader` | ImageLoaderFactoryEPS.`newImageLoader(ImageFlavor targetFlavor)` Creates and returns a new ImageLoader instance.
    `ImageLoader` | ImageLoaderFactoryRawCCITTFax.`newImageLoader(ImageFlavor targetFlavor)` Creates and returns a new ImageLoader instance.
    `ImageLoader` | ImageLoaderFactoryPNG.`newImageLoader(ImageFlavor targetFlavor)` Creates and returns a new ImageLoader instance.
    `ImageLoader` | ImageLoaderFactoryInternalTIFF.`newImageLoader(ImageFlavor targetFlavor)` Creates and returns a new ImageLoader instance.
    `ImageLoader` | ImageLoaderFactoryRaw.`newImageLoader(ImageFlavor targetFlavor)` Creates and returns a new ImageLoader instance.

    Constructors in org.apache.xmlgraphics.image.loader.impl with parameters of type ImageFlavor
    Constructor and Description
    `ImageLoaderRaw(ImageFlavor targetFlavor)` Main constructor.
    `ImageRawStream(ImageInfo info, ImageFlavor flavor, ImageRawStream.InputStreamFactory streamFactory)` Main constructor.
    `ImageRawStream(ImageInfo info, ImageFlavor flavor, java.io.InputStream in)` Constructor for a simple InputStream as parameter.

  - ### Uses of ImageFlavor in org.apache.xmlgraphics.image.loader.impl.imageio

    Methods in org.apache.xmlgraphics.image.loader.impl.imageio that return ImageFlavor
    Modifier and Type | Method and Description
    --- | ---
    `ImageFlavor[]` | ImageLoaderFactoryImageIO.`getSupportedFlavors(java.lang.String mime)` Returns an array of ImageFlavors that are supported by this implementation for a given MIME type.
    `ImageFlavor` | ImageLoaderImageIO.`getTargetFlavor()` Returns the image flavor that is returned by this ImageLoader implementation.

    Methods in org.apache.xmlgraphics.image.loader.impl.imageio with parameters of type ImageFlavor
    Modifier and Type | Method and Description
    --- | ---
    `ImageLoader` | ImageLoaderFactoryImageIO.`newImageLoader(ImageFlavor targetFlavor)` Creates and returns a new ImageLoader instance.

    Constructors in org.apache.xmlgraphics.image.loader.impl.imageio with parameters of type ImageFlavor
    Constructor and Description
    `ImageLoaderImageIO(ImageFlavor targetFlavor)` Main constructor.

  - ### Uses of ImageFlavor in org.apache.xmlgraphics.image.loader.pipeline

    Methods in org.apache.xmlgraphics.image.loader.pipeline that return ImageFlavor
    Modifier and Type | Method and Description
    --- | ---
    `ImageFlavor` | ImageRepresentation.`getFlavor()` Returns the image flavor.
    `ImageFlavor` | ImageProviderPipeline.`getTargetFlavor()` Returns the target flavor generated by this pipeline.

    Methods in org.apache.xmlgraphics.image.loader.pipeline with parameters of type ImageFlavor
    Modifier and Type | Method and Description
    --- | ---
    `ImageProviderPipeline[]` | PipelineFactory.`determineCandidatePipelines(Image sourceImage, ImageFlavor[] flavors)` Finds and returns an array of `ImageProviderPipeline` instances which can handle the convert the given `Image` and return one of the given `ImageFlavor`s.
    `ImageProviderPipeline[]` | PipelineFactory.`determineCandidatePipelines(ImageInfo imageInfo, ImageFlavor targetFlavor)` Determines all possible pipelines for the given image that can produce the requested target flavor.
    `ImageProviderPipeline[]` | PipelineFactory.`determineCandidatePipelines(ImageInfo imageInfo, ImageFlavor[] flavors)` Finds and returns an array of `ImageProviderPipeline` instances which can handle the given MIME type and return one of the given `ImageFlavor`s.
    `ImageProviderPipeline` | PipelineFactory.`newImageConverterPipeline(Image originalImage, ImageFlavor targetFlavor)` Creates and returns an `ImageProviderPipeline` that allows to load an image of the given MIME type and present it in the requested image flavor.
    `ImageProviderPipeline` | PipelineFactory.`newImageConverterPipeline(ImageInfo imageInfo, ImageFlavor targetFlavor)` Creates and returns an `ImageProviderPipeline` that allows to load an image of the given MIME type and present it in the requested image flavor.

    Constructors in org.apache.xmlgraphics.image.loader.pipeline with parameters of type ImageFlavor
    Constructor and Description
    `ImageRepresentation(ImageFlavor flavor)` Main constructor

  - ### Uses of ImageFlavor in org.apache.xmlgraphics.image.loader.spi

    Methods in org.apache.xmlgraphics.image.loader.spi that return ImageFlavor
    Modifier and Type | Method and Description
    --- | ---
    `ImageFlavor` | ImageConverter.`getSourceFlavor()` Returns the flavor that this converter expects.
    `ImageFlavor[]` | ImageLoaderFactory.`getSupportedFlavors(java.lang.String mime)` Returns an array of ImageFlavors that are supported by this implementation for a given MIME type.
    `ImageFlavor` | ImageLoader.`getTargetFlavor()` Returns the image flavor that is returned by this ImageLoader implementation.
    `ImageFlavor` | ImageConverter.`getTargetFlavor()` Returns the flavor that this converter converts images into.

    Methods in org.apache.xmlgraphics.image.loader.spi with parameters of type ImageFlavor
    Modifier and Type | Method and Description
    --- | ---
    `ImageLoaderFactory[]` | ImageImplRegistry.`getImageLoaderFactories(ImageInfo imageInfo, ImageFlavor flavor)` Returns an array of `ImageLoaderFactory` instances that support the MIME type indicated by an `ImageInfo` object and can generate the given image flavor.
    `ImageLoaderFactory` | ImageImplRegistry.`getImageLoaderFactory(ImageInfo imageInfo, ImageFlavor flavor)` Returns the best ImageLoaderFactory supporting the `ImageInfo` and image flavor.
    `int` | ImageLoaderFactory.`getUsagePenalty(java.lang.String mime, ImageFlavor flavor)` Deprecated. Redundancy with `ImageLoader.getUsagePenalty()`
    `ImageLoader` | ImageLoaderFactory.`newImageLoader(ImageFlavor targetFlavor)` Creates and returns a new ImageLoader instance.

Copyright 1999-2021 The Apache Software Foundation. All Rights Reserved.