fop 0.94

org.apache.fop.pdf
Class PDFReference

java.lang.Object
  extended by org.apache.fop.pdf.PDFReference
All Implemented Interfaces:
PDFWritable

public class PDFReference
extends java.lang.Object
implements PDFWritable

Class representing a PDF object reference. The object holds a soft reference to the actual PDF object so the garbage collector can free the object if it's not referenced elsewhere. The important thing about the class is the reference information to the actual PDF object in the PDF file.


Constructor Summary
PDFReference(PDFObject obj)
          Creates a new PDF reference.
 
Method Summary
 PDFObject getObject()
          Returns the PDF object
 java.lang.String toInlinePDFString()
          Returns a representation of this object for in-object placement, i.e.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PDFReference

public PDFReference(PDFObject obj)
Creates a new PDF reference.

Parameters:
obj - the object to be referenced
Method Detail

getObject

public PDFObject getObject()
Returns the PDF object

Returns:
the PDF object, or null if it has been released

toInlinePDFString

public java.lang.String toInlinePDFString()
Description copied from interface: PDFWritable
Returns a representation of this object for in-object placement, i.e. if the object has an object number its reference is returned. Otherwise, its PDF representation is returned.

Specified by:
toInlinePDFString in interface PDFWritable
Returns:
the String representation
See Also:
PDFWritable.toInlinePDFString()

fop 0.94

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.