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

Access	Constructor and Description
private	CCITTFactory()

Method Summary

Modifier and Type	Method and Description
public static PDImageXObject	Returns: a new Image XObject createFromByteArray(PDDocument the document to create the image as part of. document, byte[] the TIFF file in a byte array which contains a suitable CCITT compressed image byteArray) Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file stored in a byte array.
public static PDImageXObject	Returns: a new Image XObject createFromByteArray(PDDocument the document to create the image as part of. document, byte[] the TIFF file in a byte array which contains a suitable CCITT compressed image byteArray, int TIFF image number, starting from 0 number) Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file stored in a byte array.
public static PDImageXObject	Returns: a new Image XObject createFromFile(PDDocument the document to create the image as part of. document, File the TIFF file which contains a suitable CCITT compressed image file) Creates a new CCITT Fax compressed image XObject from the first image of a TIFF file.
public static PDImageXObject	Returns: a new Image XObject createFromFile(PDDocument the document to create the image as part of. document, File the TIFF file which contains a suitable CCITT compressed image file, int TIFF image number, starting from 0 number) Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file.
public static PDImageXObject	Returns: a new image XObject. createFromImage(PDDocument the document to create the image as part of. document, BufferedImage the image. image) Creates a new CCITT group 4 (T6) compressed image XObject from a b/w BufferedImage.
private static PDImageXObject	Returns: a new Image XObject, or null if no such page createFromRandomAccessImpl(PDDocument the document to create the image as part of. document, RandomAccessRead the random access TIFF file which contains a suitable CCITT compressed image reader, int TIFF image number, starting from 0 number) Creates a new CCITT Fax compressed image XObject from a TIFF file.
private static void	extractFromTiff(RandomAccessRead reader, OutputStream os, COSDictionary params, int number)
private static PDImageXObject	prepareImageXObject(PDDocument document, byte[] byteArray, int width, int height, PDColorSpace initColorSpace)
private static int	readlong(char endianess, RandomAccessRead raf)
private static int	readshort(char endianess, RandomAccessRead raf)

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

CCITTFactory	back to summary
private CCITTFactory()

Method Detail

createFromByteArray back to summary

createFromByteArray	back to summary
public static PDImageXObject createFromByteArray(PDDocument document, byte[] byteArray) throws IOException Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file stored in a byte array. Only single-strip CCITT T4 or T6 compressed TIFF files are supported. If you're not sure what TIFF files you have, use `LosslessFactory#createFromImage(PDDocument, BufferedImage)` or `CCITTFactory#createFromImage(PDDocument, BufferedImage)` instead. Parameters document:PDDocument the document to create the image as part of. byteArray:byte[] the TIFF file in a byte array which contains a suitable CCITT compressed image Returns:PDImageXObject a new Image XObject Exceptions IOException: if there is an error reading the TIFF data.

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

Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file stored in a byte array. Only single-strip CCITT T4 or T6 compressed TIFF files are supported. If you're not sure what TIFF files you have, use LosslessFactory#createFromImage(PDDocument, BufferedImage) or CCITTFactory#createFromImage(PDDocument, BufferedImage) instead.

Parameters

document:PDDocument: the document to create the image as part of.
byteArray:byte[]: the TIFF file in a byte array which contains a suitable CCITT compressed image

Returns:PDImageXObject

a new Image XObject

Exceptions

IOException:: if there is an error reading the TIFF data.

createFromByteArray back to summary

createFromByteArray	back to summary
public static PDImageXObject createFromByteArray(PDDocument document, byte[] byteArray, int number) throws IOException Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file stored in a byte array. Only single-strip CCITT T4 or T6 compressed TIFF files are supported. If you're not sure what TIFF files you have, use `LosslessFactory#createFromImage(PDDocument, BufferedImage)` or `CCITTFactory#createFromImage(PDDocument, BufferedImage)` instead. Parameters document:PDDocument the document to create the image as part of. byteArray:byte[] the TIFF file in a byte array which contains a suitable CCITT compressed image number:int TIFF image number, starting from 0 Returns:PDImageXObject a new Image XObject Exceptions IOException: if there is an error reading the TIFF data.

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

Parameters

document:PDDocument: the document to create the image as part of.
byteArray:byte[]: the TIFF file in a byte array which contains a suitable CCITT compressed image
number:int: TIFF image number, starting from 0

Returns:PDImageXObject

a new Image XObject

Exceptions

IOException:: if there is an error reading the TIFF data.

createFromFile back to summary

createFromFile	back to summary
public static PDImageXObject createFromFile(PDDocument document, File file) throws IOException Creates a new CCITT Fax compressed image XObject from the first image of a TIFF file. Only single-strip CCITT T4 or T6 compressed TIFF files are supported. If you're not sure what TIFF files you have, use `LosslessFactory#createFromImage(org.apache.pdfbox.pdmodel.PDDocument, java.awt.image.BufferedImage)` or `CCITTFactory#createFromImage(PDDocument, BufferedImage)` instead. Parameters document:PDDocument the document to create the image as part of. file:File the TIFF file which contains a suitable CCITT compressed image Returns:PDImageXObject a new Image XObject Exceptions IOException: if there is an error reading the TIFF data.

public static PDImageXObject createFromFile(PDDocument document, File file) throws IOException

Creates a new CCITT Fax compressed image XObject from the first image of a TIFF file. Only single-strip CCITT T4 or T6 compressed TIFF files are supported. If you're not sure what TIFF files you have, use LosslessFactory#createFromImage(org.apache.pdfbox.pdmodel.PDDocument, java.awt.image.BufferedImage) or CCITTFactory#createFromImage(PDDocument, BufferedImage) instead.

Parameters

document:PDDocument: the document to create the image as part of.
file:File: the TIFF file which contains a suitable CCITT compressed image

Returns:PDImageXObject

a new Image XObject

Exceptions

IOException:: if there is an error reading the TIFF data.

createFromFile back to summary

createFromFile	back to summary
public static PDImageXObject createFromFile(PDDocument document, File file, int number) throws IOException Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file. Only single-strip CCITT T4 or T6 compressed TIFF files are supported. If you're not sure what TIFF files you have, use `LosslessFactory#createFromImage(PDDocument, BufferedImage)` or `CCITTFactory#createFromImage(PDDocument, BufferedImage)` instead. Parameters document:PDDocument the document to create the image as part of. file:File the TIFF file which contains a suitable CCITT compressed image number:int TIFF image number, starting from 0 Returns:PDImageXObject a new Image XObject Exceptions IOException: if there is an error reading the TIFF data.

public static PDImageXObject createFromFile(PDDocument document, File file, int number) throws IOException

Creates a new CCITT Fax compressed image XObject from a specific image of a TIFF file. Only single-strip CCITT T4 or T6 compressed TIFF files are supported. If you're not sure what TIFF files you have, use LosslessFactory#createFromImage(PDDocument, BufferedImage) or CCITTFactory#createFromImage(PDDocument, BufferedImage) instead.

Parameters

document:PDDocument: the document to create the image as part of.
file:File: the TIFF file which contains a suitable CCITT compressed image
number:int: TIFF image number, starting from 0

Returns:PDImageXObject

a new Image XObject

Exceptions

IOException:: if there is an error reading the TIFF data.

createFromImage back to summary

createFromImage	back to summary
public static PDImageXObject createFromImage(PDDocument document, BufferedImage image) throws IOException Creates a new CCITT group 4 (T6) compressed image XObject from a b/w BufferedImage. This compression technique usually results in smaller images than those produced by `LosslessFactory#createFromImage(PDDocument, BufferedImage)`. Parameters document:PDDocument the document to create the image as part of. image:BufferedImage the image. Returns:PDImageXObject a new image XObject. Exceptions IOException: if there is an error creating the image. IllegalArgumentException: if the BufferedImage is not a b/w image.

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

Creates a new CCITT group 4 (T6) compressed image XObject from a b/w BufferedImage. This compression technique usually results in smaller images than those produced by LosslessFactory#createFromImage(PDDocument, BufferedImage).

Parameters

document:PDDocument: the document to create the image as part of.
image:BufferedImage: the image.

Returns:PDImageXObject

a new image XObject.

Exceptions

IOException:: if there is an error creating the image.
IllegalArgumentException:: if the BufferedImage is not a b/w image.

createFromRandomAccessImpl	back to summary
private static PDImageXObject createFromRandomAccessImpl(PDDocument document, RandomAccessRead reader, int number) throws IOException Creates a new CCITT Fax compressed image XObject from a TIFF file. Parameters document:PDDocument the document to create the image as part of. reader:RandomAccessRead the random access TIFF file which contains a suitable CCITT compressed image number:int TIFF image number, starting from 0 Returns:PDImageXObject a new Image XObject, or null if no such page Exceptions IOException: if there is an error reading the TIFF data.

createFromRandomAccessImpl

back to summary

private static PDImageXObject createFromRandomAccessImpl(PDDocument document, RandomAccessRead reader, int number) throws IOException

Creates a new CCITT Fax compressed image XObject from a TIFF file.

Parameters

document:PDDocument: the document to create the image as part of.
reader:RandomAccessRead: the random access TIFF file which contains a suitable CCITT compressed image
number:int: TIFF image number, starting from 0

Returns:PDImageXObject

a new Image XObject, or null if no such page

Exceptions

IOException:: if there is an error reading the TIFF data.

extractFromTiff	back to summary
private static void extractFromTiff(RandomAccessRead reader, OutputStream os, COSDictionary params, int number) throws IOException

prepareImageXObject	back to summary
private static PDImageXObject prepareImageXObject(PDDocument document, byte[] byteArray, int width, int height, PDColorSpace initColorSpace) throws IOException

readlong	back to summary
private static int readlong(char endianess, RandomAccessRead raf) throws IOException

readshort	back to summary
private static int readshort(char endianess, RandomAccessRead raf) throws IOException

public final Class CCITTFactory

Constructor Summary

Method Summary

Constructor Detail

Method Detail