com.ironsoftware.ironpdf.compression

Enum ObjectStreamMode

java.lang.Object

java.lang.Enum<ObjectStreamMode>

com.ironsoftware.ironpdf.compression.ObjectStreamMode

All Implemented Interfaces:

Serializable, Comparable<ObjectStreamMode>

public enum ObjectStreamMode
extends Enum<ObjectStreamMode>

Object stream mode used when writing the compressed PDF.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLE Write every object as a top-level indirect object (no object streams).
GENERATE Pack indirect objects into object streams.
PRESERVE Keep the input's object stream layout unchanged.

Method Summary

Modifier and Type	Method and Description
String	toWire() The wire-format string the engine expects on QPdfCompressionFlagsP.object_streams.
static ObjectStreamMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ObjectStreamMode[]	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

GENERATE

public static final ObjectStreamMode GENERATE

Pack indirect objects into object streams. Smallest output for PDF 1.5+ (default).

PRESERVE

public static final ObjectStreamMode PRESERVE

Keep the input's object stream layout unchanged.

DISABLE

public static final ObjectStreamMode DISABLE

Write every object as a top-level indirect object (no object streams). Use when consumer tools cannot read object streams.

Method Detail

values

public static ObjectStreamMode[] 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 (ObjectStreamMode c : ObjectStreamMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ObjectStreamMode 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

toWire

public String toWire()

The wire-format string the engine expects on QPdfCompressionFlagsP.object_streams.