org.apache.pdfbox.debugger.streampane

Class Stream

java.lang.Object

org.apache.pdfbox.debugger.streampane.Stream

public class Stream
extends Object

Author:

Khyrul Bashar A class that provides the COSStream in different version and related informations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	IMAGE
static String	UNFILTERED

Method Summary

Modifier and Type	Method and Description
List<String>	getFilterList() Return the available filter list.
BufferedImage	getImage(PDResources resources) Provide the image for stream.
InputStream	getStream(String key) Returns a InputStream of a partially filtered stream.
boolean	isImage() Return if this is stream is an Image XObject.
boolean	isXmlMetadata() Return if this is stream is an Metadata stream.

Methods inherited from class java.lang.Object

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

Field Detail

UNFILTERED

public static final String UNFILTERED

See Also:

Constant Field Values

IMAGE

public static final String IMAGE

See Also:

Constant Field Values

Method Detail

isImage

public boolean isImage()

Return if this is stream is an Image XObject.

Returns:

true if this an image and false otherwise.

isXmlMetadata

public boolean isXmlMetadata()

Return if this is stream is an Metadata stream.

Returns:

true if this a metadata stream and false otherwise.

getFilterList

public List<String> getFilterList()

Return the available filter list. Only "Unfiltered" is returned if there is no filter and in case of XObject image type stream "Image" is also included in the list.

Returns:

An array of String.

getStream

public InputStream getStream(String key)

Returns a InputStream of a partially filtered stream.

Parameters:

key - is an instance of String which tells which version of stream should be returned.

Returns:

an InputStream.

getImage

public BufferedImage getImage(PDResources resources)

Provide the image for stream. The stream must be image XObject.

Parameters:

resources - PDResources for the XObject.

Returns:

A BufferedImage.