org.foray.pdf.object
Class PDFEmbeddedFileStream

java.lang.Object
  org.foray.pdf.object.PDFObject
      org.foray.pdf.object.PDFStream
          org.foray.pdf.object.PDFEmbeddedFileStream

public class PDFEmbeddedFileStream
extends PDFStream

Container for a PDF Embedded File Stream. See PDF Reference, 3rd Edition, Section 3.10.3.

Field Summary

Fields inherited from class org.foray.pdf.object.PDFObject

EOL, MSG_EOL, XREF_EOL

Constructor Summary

PDFEmbeddedFileStream(PDFDocument doc, String name)
Create a PDFEmbeddedFileStream instance.

Method Summary

protected void	finalizeStreamContent() This method is an explicit opportunity for subclasses to finish writing whatever content may still need to be written to the stream before the dictionary and stream contents are written.
String	getName() Return the name by which this embedded file stream is accessed from the map of embedded files.
protected String	specialStreamDictEntries() Subclasses return any specialized dictionary entries here, so that they are included when writing the stream dictionary.

Methods inherited from class org.foray.pdf.object.PDFStream

add, addDefaultFilters, addEncryption, addFilter, addFilter, applyFilters, getDataLength, getOutputStream, output, outputStreamData, setData, setOutputStream, toPDF

Methods inherited from class org.foray.pdf.object.PDFObject

bufferToByteArray, byteArrayToStream, getCharsPerLine, getGeneration, getLogger, getNumber, getPDFDocument, pdfID, pdfReference, setNumber, stringToByteArray

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFEmbeddedFileStream

public PDFEmbeddedFileStream(PDFDocument doc,
                             String name)

Create a PDFEmbeddedFileStream instance.

Parameters:

doc - The parent PDF document.

name - The name by which this embedded file stream is accessed from the map of embedded files.

Method Detail

getName

public String getName()

Return the name by which this embedded file stream is accessed from the map of embedded files.

Returns:

The name of this embedded file stream.

finalizeStreamContent

protected void finalizeStreamContent()

Description copied from class: PDFStream

This method is an explicit opportunity for subclasses to finish writing whatever content may still need to be written to the stream before the dictionary and stream contents are written.

Specified by:

finalizeStreamContent in class PDFStream

specialStreamDictEntries

protected String specialStreamDictEntries()

Description copied from class: PDFStream

Subclasses return any specialized dictionary entries here, so that they are included when writing the stream dictionary.

Specified by:

specialStreamDictEntries in class PDFStream

Returns:

Any specialized dictionary entries.