Module org.sejda.sambox
Package org.sejda.sambox.pdmodel.common

Class PDStream

java.lang.Object
org.sejda.sambox.pdmodel.common.PDStream
All Implemented Interfaces:
COSObjectable
Direct Known Subclasses:
PDEmbeddedFile, PDMetadata, PDObjectStream
public class PDStream extends Object implements COSObjectable
A PDStream represents a stream in a PDF document. Streams are tied to a single PDF document.
Author:
Ben Litchfield

  • Constructor Details

    • PDStream

      public PDStream()
      This will create a new PDStream object.

    • PDStream

      public PDStream(COSStream str)
      Constructor.
      Parameters:
      str - The stream parameter.

    • PDStream

      public PDStream(InputStream input) throws IOException
      Constructor. Reads all data from the input stream and embeds it into the document, this will close the InputStream.
      Parameters:
      input - The stream parameter.
      Throws:
      IOException - If there is an error creating the stream in the document.

    • PDStream

      public PDStream(InputStream input, COSName filter) throws IOException
      Constructor. Reads all data from the input stream and embeds it into the document with the given filter applied. This method closes the InputStream.
      Parameters:
      input - The stream parameter.
      filter - Filter to apply to the stream.
      Throws:
      IOException - If there is an error creating the stream in the document.

    • PDStream

      public PDStream(InputStream input, COSArray filters) throws IOException
      Constructor. Reads all data from the input stream and embeds it into the document with the given filters applied. This method closes the InputStream.
      Parameters:
      input - The stream parameter.
      filters - Filters to apply to the stream.
      Throws:
      IOException - If there is an error creating the stream in the document.

    • PDStream

      public PDStream(InputStream input, COSBase filter) throws IOException
      Constructor. Reads all data from the input stream and embeds it into the document, this will close the InputStream.
      Parameters:
      input - The stream parameter.
      filter - Filter to apply to the stream.
      Throws:
      IOException - If there is an error creating the stream in the document.

  • Method Details

    • getCOSObject

      public COSStream getCOSObject()
      Convert this standard java object to a COS object.
      Specified by:
      getCOSObject in interface COSObjectable
      Returns:
      The cos object that matches this Java object.

    • createOutputStream

      public OutputStream createOutputStream()
      This will get a stream that can be written to.
      Returns:
      An output stream to write data to.
      Throws:
      IOException - If an IO error occurs during writing.

    • createOutputStream

      public OutputStream createOutputStream(COSName filter)
      This will get a stream that can be written to, with the given filter.
      Parameters:
      filter - the filter to be used.
      Returns:
      An output stream to write data to.
      Throws:
      IOException - If an IO error occurs during writing.

    • createInputStream

      public InputStream createInputStream() throws IOException
      This will get a stream that can be read from.
      Returns:
      An input stream that can be read from.
      Throws:
      IOException - If an IO error occurs during reading.

    • getLength

      public int getLength()
      This will get the length of the filtered/compressed stream. This is readonly in the PD Model and will be managed by this class.
      Returns:
      The length of the filtered stream.

    • getFilters

      public List<COSName> getFilters()
      This will get the list of filters that are associated with this stream. Or null if there are none.
      Returns:
      A list of all encoding filters to apply to this stream.

    • setFilters

      public void setFilters(List<COSName> filters)
      This will set the filters that are part of this stream.
      Parameters:
      filters - The filters that are part of this stream.

    • getDecodeParms

      public List<Object> getDecodeParms() throws IOException
      Get the list of decode parameters. Each entry in the list will refer to an entry in the filters list.
      Returns:
      The list of decode parameters.
      Throws:
      IOException - if there is an error retrieving the parameters.

    • setDecodeParms

      public void setDecodeParms(List<?> decodeParams)
      This will set the list of decode parameterss.
      Parameters:
      decodeParams - The list of decode parameterss.

    • getFile

      public PDFileSpecification getFile()
      This will get the file specification for this stream. This is only required for external files.
      Returns:
      The file specification.

    • setFile

      public void setFile(PDFileSpecification f)
      Set the file specification.
      Parameters:
      f - The file specification.

    • getFileFilters

      public List<String> getFileFilters()
      This will get the list of filters that are associated with this stream. Or null if there are none.
      Returns:
      A list of all encoding filters to apply to this stream.

    • setFileFilters

      public void setFileFilters(List<String> filters)
      This will set the filters that are part of this stream.
      Parameters:
      filters - The filters that are part of this stream.

    • getFileDecodeParams

      public List<Object> getFileDecodeParams() throws IOException
      Get the list of decode parameters. Each entry in the list will refer to an entry in the filters list.
      Returns:
      The list of decode parameters.
      Throws:
      IOException - if there is an error retrieving the parameters.

    • setFileDecodeParams

      public void setFileDecodeParams(List<?> decodeParams)
      This will set the list of decode params.
      Parameters:
      decodeParams - The list of decode params.

    • toByteArray

      public byte[] toByteArray() throws IOException
      This will copy the stream into a byte array.
      Returns:
      The byte array of the filteredStream
      Throws:
      IOException - When getFilteredStream did not work

    • getMetadata

      public PDMetadata getMetadata()
      Get the metadata that is part of the document catalog. This will return null if there is no meta data for this object.
      Returns:
      The metadata for this object.
      Throws:
      IllegalStateException - if the value of the metadata entry is different from a stream or null

    • setMetadata

      public void setMetadata(PDMetadata meta)
      Set the metadata for this object. This can be null.
      Parameters:
      meta - The meta data for this object.

    • getDecodedStreamLength

      public int getDecodedStreamLength()
      Get the decoded stream length.
      Returns:
      the decoded stream length
      Since:
      Apache PDFBox 1.1.0
      See Also:

    • setDecodedStreamLength

      public void setDecodedStreamLength(int decodedStreamLength)
      Set the decoded stream length.
      Parameters:
      decodedStreamLength - the decoded stream length
      Since:
      Apache PDFBox 1.1.0
      See Also: