org.foray.pdf.object
Class PDFFileSpec

java.lang.Object
  org.foray.pdf.object.PDFObject
      org.foray.pdf.object.PDFFileSpec

public class PDFFileSpec
extends PDFObject

A File Specification Dictionary.

See Also:

"PDF Reference, 3rd Edition, Section 3.10.2"

Field Summary

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

EOL, MSG_EOL, XREF_EOL

Constructor Summary

PDFFileSpec(PDFDocument doc, PDFEmbeddedFileStream efs)
Constructor for the case of specifying an embedded file.

PDFFileSpec(PDFDocument doc, String filename)
Constructor for the case of specifying an external file.

Method Summary

String

toPDF() Generates the PDF text necessary to represent the object, returning it as a String.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFFileSpec

public PDFFileSpec(PDFDocument doc,
                   String filename)

Constructor for the case of specifying an external file.

Parameters:

doc - The parent PDF document.

filename - the filename represented by this object

PDFFileSpec

public PDFFileSpec(PDFDocument doc,
                   PDFEmbeddedFileStream efs)

Constructor for the case of specifying an embedded file.

Parameters:

doc - The parent PDF document.

efs - The embedded file stream that is being referenced.

Method Detail

toPDF

public String toPDF()

Description copied from class: PDFObject

Generates the PDF text necessary to represent the object, returning it as a String.

Returns:

The PDF text necessary to represent the object.