Package com.ironsoftware.ironpdf.compression

Enum BitonalCompressionMode

java.lang.Object

java.lang.Enum<BitonalCompressionMode>

com.ironsoftware.ironpdf.compression.BitonalCompressionMode

All Implemented Interfaces:

Serializable, Comparable<BitonalCompressionMode>

public enum BitonalCompressionMode
extends Enum<BitonalCompressionMode>

How the advanced compression pipeline handles bitonal (1-bit black/white) image encoding for scanned documents. See AdvancedCompressionOptions.setBitonalMode(BitonalCompressionMode).

Enum Constant Summary

Enum Constants

Enum Constant	Description
FORCE	Force every eligible 8-bit image to be thresholded to 1-bit and CCITT Group 4 encoded.
OFF	Disabled (default).

Method Summary

Modifier and Type	Method	Description
int	getValue()	The wire value the engine expects on PdfiumCompressImagesRequestP.bitonal_mode.
static BitonalCompressionMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BitonalCompressionMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OFF

public static final BitonalCompressionMode OFF

Disabled (default). Images are compressed with the normal JPEG pipeline.

FORCE

public static final BitonalCompressionMode FORCE

Force every eligible 8-bit image to be thresholded to 1-bit and CCITT Group 4 encoded. The result is kept only when it is smaller than the JPEG encoding, so it never enlarges an image, but thresholding is lossy: use it only for black-and-white scans or line art, not colour or photographic content.

Method Detail

values

public static BitonalCompressionMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BitonalCompressionMode c : BitonalCompressionMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BitonalCompressionMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

The wire value the engine expects on PdfiumCompressImagesRequestP.bitonal_mode.

Returns:

0 for off, 1 for force