org.apache.fop.pdf

Class PDFFileSpec

java.lang.Object

org.apache.fop.pdf.PDFObject

org.apache.fop.pdf.PDFFileSpec

All Implemented Interfaces:

PDFWritable

public class PDFFileSpec
extends PDFObject

class representing a /FileSpec object.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	filename the filename

Fields inherited from class org.apache.fop.pdf.PDFObject

DATE_FORMAT, log

Constructor Summary

Constructors

Constructor and Description
PDFFileSpec(java.lang.String filename) create a /FileSpec object.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	contentEquals(PDFObject obj) Check if the other PDFObject has the same content as the current object.
java.lang.String	toPDFString() This method returns a String representation of the PDF object.

Methods inherited from class org.apache.fop.pdf.PDFObject

encode, encodeBinaryToHexString, encodeString, encodeText, formatDateTime, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, output, outputInline, referencePDF, setDocument, setObjectNumber, setParent, toPDF

Methods inherited from class java.lang.Object

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

Field Detail

filename

protected java.lang.String filename

the filename

Constructor Detail

PDFFileSpec

public PDFFileSpec(java.lang.String filename)

create a /FileSpec object.

Parameters:

filename - the filename represented by this object

Method Detail

toPDFString

public java.lang.String toPDFString()

This method returns a String representation of the PDF object. The result is normally converted/encoded to a byte array by toPDF(). Only use this method to implement the serialization if the object can be fully represented as text. If the PDF representation of the object contains binary content use toPDF() or output(OutputStream) instead. This applies to any object potentially containing a string object because string object are encrypted and therefore need to be binary.

Overrides:

toPDFString in class PDFObject

Returns:

String the String representation

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.