fop 0.95

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.
PDFReference(java.lang.String ref)
          Creates a new PDF reference, but without a reference to the original object.
 
Method Summary
 PDFObject getObject()
          Returns the PDF object
 void outputInline(java.io.OutputStream out, java.io.Writer writer)
          Writes a "direct object" (inline object) representation to the stream.
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PDFReference

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

Parameters:
obj - the object to be referenced

PDFReference

public PDFReference(java.lang.String ref)
Creates a new PDF reference, but without a reference to the original object.

Parameters:
ref - an object reference
Method Detail

getObject

public PDFObject getObject()
Returns the PDF object

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

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object

outputInline

public void outputInline(java.io.OutputStream out,
                         java.io.Writer writer)
                  throws java.io.IOException
Writes a "direct object" (inline object) representation to the stream. A Writer is given for optimized encoding of text content. Since the Writer is buffered, make sure flush() is called before any direct calls to out are made.

Specified by:
outputInline in interface PDFWritable
Parameters:
out - the OutputStream (for binary content)
writer - the Writer (for text content, wraps the above OutputStream)
Throws:
java.io.IOException - if an I/O error occurs

fop 0.95

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