com.itextpdf.kernel.pdf

Class PdfStream

java.lang.Object

com.itextpdf.kernel.pdf.PdfObject

com.itextpdf.kernel.pdf.PdfDictionary

com.itextpdf.kernel.pdf.PdfStream

All Implemented Interfaces:

Serializable

public class PdfStream
extends PdfDictionary

Representation of a stream as described in the PDF Specification.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	compressionLevel
protected PdfOutputStream	outputStream

Fields inherited from class com.itextpdf.kernel.pdf.PdfObject

ARRAY, BOOLEAN, DICTIONARY, FLUSHED, FORBID_RELEASE, FREE, INDIRECT_REFERENCE, indirectReference, LITERAL, MODIFIED, MUST_BE_FLUSHED, MUST_BE_INDIRECT, NAME, NULL, NUMBER, ORIGINAL_OBJECT_STREAM, READ_ONLY, READING, STREAM, STRING, UNENCRYPTED

Constructor Summary

Constructors

Modifier	Constructor and Description
	PdfStream() Creates an empty PdfStream instance.
	PdfStream(byte[] bytes) Creates a PdfStream instance.
	PdfStream(byte[] bytes, int compressionLevel) Constructs a PdfStream-object.
	PdfStream(int compressionLevel) Constructs a PdfStream-object.
protected	PdfStream(OutputStream outputStream)
	PdfStream(PdfDocument doc, InputStream inputStream) Creates an efficient stream.
	PdfStream(PdfDocument doc, InputStream inputStream, int compressionLevel) Creates an efficient stream.

Method Summary

Modifier and Type	Method and Description
protected void	copyContent(PdfObject from, PdfDocument document) Copies object content from object 'from'.
PdfStream	copyTo(PdfDocument document) Copies object to a specified document.
PdfStream	copyTo(PdfDocument document, boolean allowDuplicating) Copies object to a specified document.
byte[]	getBytes() Gets decoded stream bytes.
byte[]	getBytes(boolean decoded) Gets stream bytes.
int	getCompressionLevel() Gets compression level of this PdfStream.
protected InputStream	getInputStream()
int	getLength()
protected long	getOffset()
PdfOutputStream	getOutputStream() Gets output stream.
byte	getType() Gets object type.
protected void	initOutputStream(OutputStream stream)
PdfStream	makeIndirect(PdfDocument document) Marks object to be saved as indirect.
PdfStream	makeIndirect(PdfDocument document, PdfIndirectReference reference) Marks object to be saved as indirect.
protected PdfStream	newInstance() Creates new instance of object.
protected void	releaseContent() Release content of PdfStream.
void	setCompressionLevel(int compressionLevel) Sets compression level of this PdfStream.
void	setData(byte[] bytes) Sets bytes as stream's content.
void	setData(byte[] bytes, boolean append) Sets or appends bytes to stream content.
protected void	updateLength(int length) Update length manually in case its correction.

Methods inherited from class com.itextpdf.kernel.pdf.PdfDictionary

clear, clone, containsKey, containsValue, copyTo, directEntrySet, directValues, entrySet, get, get, getAsArray, getAsBool, getAsBoolean, getAsDictionary, getAsFloat, getAsInt, getAsName, getAsNumber, getAsRectangle, getAsStream, getAsString, isEmpty, keySet, mergeDifferent, put, putAll, remove, size, toString, values, values

Methods inherited from class com.itextpdf.kernel.pdf.PdfObject

checkState, clearState, clone, flush, flush, getIndirectReference, isArray, isBoolean, isDictionary, isFlushed, isIndirect, isIndirectReference, isLiteral, isModified, isName, isNull, isNumber, isStream, isString, release, setIndirectReference, setModified, setState

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

compressionLevel

protected int compressionLevel

outputStream

protected PdfOutputStream outputStream

Constructor Detail

PdfStream

public PdfStream(byte[] bytes,
                 int compressionLevel)

Constructs a PdfStream-object.

Parameters:

bytes - initial content of PdfOutputStream.

compressionLevel - the compression level (0 = best speed, 9 = best compression, -1 is default)

PdfStream

public PdfStream(byte[] bytes)

Creates a PdfStream instance.

Parameters:

bytes - bytes to write to the PdfStream

PdfStream

public PdfStream(PdfDocument doc,
                 InputStream inputStream,
                 int compressionLevel)

Creates an efficient stream. No temporary array is ever created. The InputStream is totally consumed but is not closed. The general usage is:

 PdfDocument document = ?;
 InputStream in = ?;
 PdfStream stream = new PdfStream(document, in, PdfOutputStream.DEFAULT_COMPRESSION);
 ?
 stream.flush();
 in.close();
 

Parameters:

inputStream - the data to write to this stream

compressionLevel - the compression level (0 = best speed, 9 = best compression, -1 is default)

PdfStream

public PdfStream(PdfDocument doc,
                 InputStream inputStream)

Creates an efficient stream. No temporary array is ever created. The InputStream is totally consumed but is not closed. The general usage is:

 PdfDocument document = ?;
 InputStream in = ?;
 PdfStream stream = new PdfStream(document, in);
 stream.flush();
 in.close();
 

Parameters:

inputStream - the data to write to this stream

PdfStream

public PdfStream(int compressionLevel)

Constructs a PdfStream-object.

Parameters:

compressionLevel - the compression level (0 = best speed, 9 = best compression, -1 is default)

PdfStream

public PdfStream()

Creates an empty PdfStream instance.

PdfStream

protected PdfStream(OutputStream outputStream)

Method Detail

getOutputStream

public PdfOutputStream getOutputStream()

Gets output stream.

Returns:

output stream

getCompressionLevel

public int getCompressionLevel()

Gets compression level of this PdfStream. For more details @see Deflater.

Returns:

compression level.

setCompressionLevel

public void setCompressionLevel(int compressionLevel)

Sets compression level of this PdfStream. For more details @see Deflater.

Parameters:

compressionLevel - the compression level (0 = best speed, 9 = best compression, -1 is default)

getType

public byte getType()

Description copied from class: PdfObject

Gets object type.

Overrides:

getType in class PdfDictionary

Returns:

object type.

getLength

public int getLength()

getBytes

public byte[] getBytes()

Gets decoded stream bytes.

Returns:

byte[]

getBytes

public byte[] getBytes(boolean decoded)

Gets stream bytes.

Parameters:

decoded - true if to get decoded stream bytes, otherwise false.

Returns:

byte content of the PdfStream. Byte content will be null, if the PdfStream was created by InputStream.

setData

public void setData(byte[] bytes)

Sets bytes as stream's content. Could not be used with streams which were created by InputStream.

Parameters:

bytes - new content for stream; if null then stream's content will be discarded

setData

public void setData(byte[] bytes,
                    boolean append)

Sets or appends bytes to stream content. Could not be used with streams which were created by InputStream.

Parameters:

bytes - New content for stream. These bytes are considered to be a raw data (i.e. not encoded/compressed/encrypted) and if it's not true, the corresponding filters shall be set to the PdfStream object manually. Data compression generally should be configured via setCompressionLevel(int) and is handled on stream writing to the output document. If null and append is false then stream's content will be discarded.

append - If set to true then bytes will be appended to the end, rather then replace original content. The original content will be decoded if needed.

makeIndirect

public PdfStream makeIndirect(PdfDocument document)

Marks object to be saved as indirect.

Overrides:

makeIndirect in class PdfDictionary

Parameters:

document - a document the indirect reference will belong to.

Returns:

object itself.

makeIndirect

public PdfStream makeIndirect(PdfDocument document,
                              PdfIndirectReference reference)

Marks object to be saved as indirect.

Overrides:

makeIndirect in class PdfDictionary

Parameters:

document - a document the indirect reference will belong to.

Returns:

object itself.

copyTo

public PdfStream copyTo(PdfDocument document)

Copies object to a specified document. Works only for objects that are read from existing document, otherwise an exception is thrown.

Overrides:

copyTo in class PdfDictionary

Parameters:

document - document to copy object to.

Returns:

copied object.

copyTo

public PdfStream copyTo(PdfDocument document,
                        boolean allowDuplicating)

Copies object to a specified document. Works only for objects that are read from existing document, otherwise an exception is thrown.

Overrides:

copyTo in class PdfDictionary

Parameters:

document - document to copy object to.

allowDuplicating - indicates if to allow copy objects which already have been copied. If object is associated with any indirect reference and allowDuplicating is false then already existing reference will be returned instead of copying object. If allowDuplicating is true then object will be copied and new indirect reference will be assigned.

Returns:

copied object.

newInstance

protected PdfStream newInstance()

Description copied from class: PdfObject

Creates new instance of object.

Overrides:

newInstance in class PdfDictionary

Returns:

new instance of object.

getOffset

protected long getOffset()

updateLength

protected void updateLength(int length)

Update length manually in case its correction.

See Also:

PdfReader.checkPdfStreamLength(PdfStream)

copyContent

protected void copyContent(PdfObject from,
                           PdfDocument document)

Description copied from class: PdfObject

Copies object content from object 'from'.

Overrides:

copyContent in class PdfDictionary

Parameters:

from - object to copy content from.

document - document to copy object to.

initOutputStream

protected void initOutputStream(OutputStream stream)

releaseContent

protected void releaseContent()

Release content of PdfStream.

Overrides:

releaseContent in class PdfDictionary

getInputStream

protected InputStream getInputStream()