Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.graphics.image.JPEGFactory

Modifier and Type	Class and Description
private static class	JPEGFactory.Dimensions

Modifier and Type	Field and Description
private static final Log	LOG

Access	Constructor and Description
private	JPEGFactory()

Method Summary

Modifier and Type	Method and Description
public static PDImageXObject	Returns: a new Image XObject createFromByteArray(PDDocument the document where the image will be created document, byte[] bytes of JPEG image byteArray) Creates a new JPEG Image XObject from a byte array containing JPEG data.
public static PDImageXObject	Returns: a new Image XObject createFromImage(PDDocument the document where the image will be created document, BufferedImage the BufferedImage to embed image) Creates a new JPEG PDImageXObject from a BufferedImage.
public static PDImageXObject	Returns: a new Image XObject createFromImage(PDDocument the document where the image will be created document, BufferedImage the BufferedImage to embed image, float The desired JPEG compression quality; between 0 (best compression) and 1 (best image quality). See `ImageWriteParam#setCompressionQuality(float)` for more details. quality) Creates a new JPEG PDImageXObject from a BufferedImage and a given quality.
public static PDImageXObject	Returns: a new Image XObject createFromImage(PDDocument the document where the image will be created document, BufferedImage the BufferedImage to embed image, float The desired JPEG compression quality; between 0 (best compression) and 1 (best image quality). See `ImageWriteParam#setCompressionQuality(float)` for more details. quality, int the desired dpi (resolution) value of the JPEG to be stored in metadata. This value has no influence on image content or size. dpi) Creates a new JPEG Image XObject from a BufferedImage, a given quality and dpi metadata.
public static PDImageXObject	Returns: a new Image XObject createFromStream(PDDocument the document where the image will be created document, InputStream a stream of JPEG data stream) Creates a new JPEG Image XObject from an input stream containing JPEG data.
private static PDImageXObject	createJPEG(PDDocument document, BufferedImage image, float quality, int dpi)
private static byte[]	encodeImageToJPEGStream(BufferedImage image, float quality, int dpi)
private static BufferedImage	getAlphaImage(BufferedImage image)
private static BufferedImage	getColorImage(BufferedImage image)
private static PDColorSpace	getColorSpaceFromAWT(BufferedImage awtImage)
private static ImageWriter	getJPEGImageWriter()
private static int	getNumComponentsFromImageMetadata(ImageReader reader)
private static JPEGFactory.Dimensions	retrieveDimensions(ByteArrayInputStream stream)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

LOG	back to summary
private static final Log LOG

JPEGFactory	back to summary
private JPEGFactory()

Method Detail

createFromByteArray	back to summary
public static PDImageXObject createFromByteArray(PDDocument document, byte[] byteArray) throws IOException Creates a new JPEG Image XObject from a byte array containing JPEG data. Parameters document:PDDocument the document where the image will be created byteArray:byte[] bytes of JPEG image Returns:PDImageXObject a new Image XObject Exceptions IOException: if the input stream cannot be read

createFromByteArray

back to summary

public static PDImageXObject createFromByteArray(PDDocument document, byte[] byteArray) throws IOException

Creates a new JPEG Image XObject from a byte array containing JPEG data.

Parameters

document:PDDocument: the document where the image will be created
byteArray:byte[]: bytes of JPEG image

Returns:PDImageXObject

a new Image XObject

Exceptions

IOException:: if the input stream cannot be read

createFromImage back to summary

createFromImage	back to summary
public static PDImageXObject createFromImage(PDDocument document, BufferedImage image) throws IOException Creates a new JPEG PDImageXObject from a BufferedImage. Do not read a JPEG image from a stream/file and call this method; you'll get more speed and quality by calling `createFromStream()` instead. Parameters document:PDDocument the document where the image will be created image:BufferedImage the BufferedImage to embed Returns:PDImageXObject a new Image XObject Exceptions IOException: if the JPEG data cannot be written

public static PDImageXObject createFromImage(PDDocument document, BufferedImage image) throws IOException

Creates a new JPEG PDImageXObject from a BufferedImage.

Do not read a JPEG image from a stream/file and call this method; you'll get more speed and quality by calling createFromStream() instead.

Parameters

document:PDDocument: the document where the image will be created
image:BufferedImage: the BufferedImage to embed

Returns:PDImageXObject

a new Image XObject

Exceptions

IOException:: if the JPEG data cannot be written

createFromImage back to summary

createFromImage	back to summary
public static PDImageXObject createFromImage(PDDocument document, BufferedImage image, float quality) throws IOException Creates a new JPEG PDImageXObject from a BufferedImage and a given quality. Do not read a JPEG image from a stream/file and call this method; you'll get more speed and quality by calling `createFromStream()` instead. The image will be created with a dpi value of 72 to be stored in metadata. Parameters document:PDDocument the document where the image will be created image:BufferedImage the BufferedImage to embed quality:float The desired JPEG compression quality; between 0 (best compression) and 1 (best image quality). See `ImageWriteParam#setCompressionQuality(float)` for more details. Returns:PDImageXObject a new Image XObject Exceptions IOException: if the JPEG data cannot be written

public static PDImageXObject createFromImage(PDDocument document, BufferedImage image, float quality) throws IOException

Creates a new JPEG PDImageXObject from a BufferedImage and a given quality.

Do not read a JPEG image from a stream/file and call this method; you'll get more speed and quality by calling createFromStream() instead. The image will be created with a dpi value of 72 to be stored in metadata.

Parameters

document:PDDocument: the document where the image will be created
image:BufferedImage: the BufferedImage to embed
quality:float: The desired JPEG compression quality; between 0 (best compression) and 1 (best image quality). See ImageWriteParam#setCompressionQuality(float) for more details.

Returns:PDImageXObject

a new Image XObject

Exceptions

IOException:: if the JPEG data cannot be written

createFromImage back to summary

createFromImage	back to summary
public static PDImageXObject createFromImage(PDDocument document, BufferedImage image, float quality, int dpi) throws IOException Creates a new JPEG Image XObject from a BufferedImage, a given quality and dpi metadata. Do not read a JPEG image from a stream/file and call this method; you'll get more speed and quality by calling `createFromStream()` instead. Parameters document:PDDocument the document where the image will be created image:BufferedImage the BufferedImage to embed quality:float The desired JPEG compression quality; between 0 (best compression) and 1 (best image quality). See `ImageWriteParam#setCompressionQuality(float)` for more details. dpi:int the desired dpi (resolution) value of the JPEG to be stored in metadata. This value has no influence on image content or size. Returns:PDImageXObject a new Image XObject Exceptions IOException: if the JPEG data cannot be written

public static PDImageXObject createFromImage(PDDocument document, BufferedImage image, float quality, int dpi) throws IOException

Creates a new JPEG Image XObject from a BufferedImage, a given quality and dpi metadata.

Do not read a JPEG image from a stream/file and call this method; you'll get more speed and quality by calling createFromStream() instead.

Parameters

document:PDDocument: the document where the image will be created
image:BufferedImage: the BufferedImage to embed
quality:float: The desired JPEG compression quality; between 0 (best compression) and 1 (best image quality). See ImageWriteParam#setCompressionQuality(float) for more details.
dpi:int: the desired dpi (resolution) value of the JPEG to be stored in metadata. This value has no influence on image content or size.

Returns:PDImageXObject

a new Image XObject

Exceptions

IOException:: if the JPEG data cannot be written

createFromStream	back to summary
public static PDImageXObject createFromStream(PDDocument document, InputStream stream) throws IOException Creates a new JPEG Image XObject from an input stream containing JPEG data. The input stream data will be preserved and embedded in the PDF file without modification. Parameters document:PDDocument the document where the image will be created stream:InputStream a stream of JPEG data Returns:PDImageXObject a new Image XObject Exceptions IOException: if the input stream cannot be read

createFromStream

back to summary

public static PDImageXObject createFromStream(PDDocument document, InputStream stream) throws IOException

Creates a new JPEG Image XObject from an input stream containing JPEG data. The input stream data will be preserved and embedded in the PDF file without modification.

Parameters

document:PDDocument: the document where the image will be created
stream:InputStream: a stream of JPEG data

Returns:PDImageXObject

a new Image XObject

Exceptions

IOException:: if the input stream cannot be read

createJPEG	back to summary
private static PDImageXObject createJPEG(PDDocument document, BufferedImage image, float quality, int dpi) throws IOException

encodeImageToJPEGStream	back to summary
private static byte[] encodeImageToJPEGStream(BufferedImage image, float quality, int dpi) throws IOException

getAlphaImage	back to summary
private static BufferedImage getAlphaImage(BufferedImage image)

getColorImage	back to summary
private static BufferedImage getColorImage(BufferedImage image)

getColorSpaceFromAWT	back to summary
private static PDColorSpace getColorSpaceFromAWT(BufferedImage awtImage)

getJPEGImageWriter	back to summary
private static ImageWriter getJPEGImageWriter() throws IOException

getNumComponentsFromImageMetadata	back to summary
private static int getNumComponentsFromImageMetadata(ImageReader reader) throws IOException

retrieveDimensions	back to summary
private static JPEGFactory.Dimensions retrieveDimensions(ByteArrayInputStream stream) throws IOException

Modifier and Type	Field and Description
private int	height
private int	numComponents
private int	width

public final Class JPEGFactory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class JPEGFactory.Dimensions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail