Package org.apache.fop.pdf

Class PDFFileSpec

java.lang.Object
org.apache.fop.pdf.PDFObject
org.apache.fop.pdf.PDFDictionary
org.apache.fop.pdf.PDFFileSpec
All Implemented Interfaces:
PDFWritable
public class PDFFileSpec extends PDFDictionary
Class representing a /FileSpec object.

  • Constructor Details

    • PDFFileSpec

      public PDFFileSpec(String filename)
      create a /FileSpec object.
      Parameters:
      filename - the filename represented by this object

    • PDFFileSpec

      public PDFFileSpec(String filename, String unicodeFilename)
      create a /FileSpec object.
      Parameters:
      filename - the filename represented by this object
      unicodeFilename - the unicode filename represented by this object

  • Method Details

    • getFilename

      public String getFilename()
      Gets the filename.
      Returns:
      filename

    • getUnicodeFilename

      public String getUnicodeFilename()
      Gets the unicode filename
      Returns:
      unicode filename

    • setEmbeddedFile

      public void setEmbeddedFile(PDFDictionary embeddedFileDict)
      Associates an dictionary with pointers to embedded file streams with this file spec.
      Parameters:
      embeddedFileDict - the dictionary with pointers to embedded file streams

    • setDescription

      public void setDescription(String description)
      Sets a description for the file spec.
      Parameters:
      description - the description
      Since:
      PDF 1.6

    • contentEquals

      protected boolean contentEquals(PDFObject obj)
      Check if the other PDFObject has the same content as the current object.

      Note: This function has a contract which is less binding than Object.equals(Object). Whereas equals would require all values to be identical, this method is not required to check everything. In the case of PDFObjects, this means that the overriding function does not have to check for PDFObject.getObjectID().

      Overrides:
      contentEquals in class PDFObject
      Parameters:
      obj - object to compare to.
      Returns:
      true if the other object has the same content.