org.sejda.sambox.output

Enum WriteOption

java.lang.Object

java.lang.Enum<WriteOption>

org.sejda.sambox.output.WriteOption

All Implemented Interfaces:

Serializable, Comparable<WriteOption>

public enum WriteOption
extends Enum<WriteOption>

Options that can be selected when writing a PDF document.

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPRESS_STREAMS Adds a Flate filter to the streams if not already there
OBJECT_STREAMS Writes pdf objects using objects stream
SYNC_BODY_WRITE Writes the document using the synchronous writer as opposed to the default async one
XREF_STREAM Writes the xref data as stream

Method Summary

Modifier and Type	Method and Description
static WriteOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static WriteOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XREF_STREAM

public static final WriteOption XREF_STREAM

Writes the xref data as stream

SYNC_BODY_WRITE

public static final WriteOption SYNC_BODY_WRITE

Writes the document using the synchronous writer as opposed to the default async one

OBJECT_STREAMS

public static final WriteOption OBJECT_STREAMS

Writes pdf objects using objects stream

COMPRESS_STREAMS

public static final WriteOption COMPRESS_STREAMS

Adds a Flate filter to the streams if not already there

Method Detail

values

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

Returns:

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

valueOf

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