Top Description Fields Constructors Methods
org.apache.pdfbox.pdfwriter.compress

public Class CompressParameters

extends Object
Class Inheritance
An instance of this class centralizes and provides the configuration for a PDF compression.
Author
Christian Appl

Field Summary

Modifier and TypeField and Description
public static final CompressParameters
DEFAULT_COMPRESSION

public static final int
DEFAULT_OBJECT_STREAM_SIZE

public static final CompressParameters
NO_COMPRESSION

private final int
objectStreamSize

Constructor Summary

AccessConstructor and Description
public
CompressParameters()

public
CompressParameters(int
The number of objects, that can be contained in compressed object streams.
objectStreamSize)

Sets the number of objects, that can be contained in compressed object streams.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The number of objects, that can be contained in compressed object streams.
getObjectStreamSize()

Returns the number of objects, that can be contained in compressed object streams.

public boolean

Returns:

true if compression is enabled.
isCompress()

Indicates whether the creation of compressed object streams is enabled or not.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULT_COMPRESSIONback to summary
public static final CompressParameters DEFAULT_COMPRESSION
DEFAULT_OBJECT_STREAM_SIZEback to summary
public static final int DEFAULT_OBJECT_STREAM_SIZE
NO_COMPRESSIONback to summary
public static final CompressParameters NO_COMPRESSION
objectStreamSizeback to summary
private final int objectStreamSize

Constructor Detail

CompressParametersback to summary
public CompressParameters()
CompressParametersback to summary
public CompressParameters(int objectStreamSize)

Sets the number of objects, that can be contained in compressed object streams. Higher object stream sizes may cause PDF readers to slow down during the rendering of PDF documents, therefore a reasonable value should be selected. A value of 0 disables the compression.

Parameters
objectStreamSize:int

The number of objects, that can be contained in compressed object streams.

Method Detail

getObjectStreamSizeback to summary
public int getObjectStreamSize()

Returns the number of objects, that can be contained in compressed object streams. Higher object stream sizes may cause PDF readers to slow down during the rendering of PDF documents, therefore a reasonable value should be selected.

Returns:int

The number of objects, that can be contained in compressed object streams.

isCompressback to summary
public boolean isCompress()

Indicates whether the creation of compressed object streams is enabled or not.

Returns:boolean

true if compression is enabled.