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.
-
-
Field Summary
-
Fields inherited from class org.apache.fop.pdf.PDFDictionary
entries, order
-
-
Constructor Summary
Constructors Constructor Description PDFFileSpec(java.lang.String filename)
create a /FileSpec object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
contentEquals(PDFObject obj)
Check if the other PDFObject has the same content as the current object.void
setDescription(java.lang.String description)
Sets a description for the file spec.void
setEmbeddedFile(PDFDictionary embeddedFileDict)
Associates an dictionary with pointers to embedded file streams with this file spec.-
Methods inherited from class org.apache.fop.pdf.PDFDictionary
containsKey, get, getChildren, getChildren, keySet, output, put, put, remove, writeDictionary
-
Methods inherited from class org.apache.fop.pdf.PDFObject
encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, outputInline, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, toPDF, toPDFString
-
-
-
-
Method Detail
-
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(java.lang.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 forPDFObject.getObjectID()
.- Overrides:
contentEquals
in classPDFObject
- Parameters:
obj
- object to compare to.- Returns:
- true if the other object has the same content.
-
-