Module com.github.librepdf.openpdf

Package org.openpdf.text.pdf

Class PdfWriter.PdfBody.PdfCrossReference

java.lang.Object

org.openpdf.text.pdf.PdfWriter.PdfBody.PdfCrossReference

All Implemented Interfaces:

Comparable<PdfWriter.PdfBody.PdfCrossReference>

Enclosing class:

PdfWriter.PdfBody

public static class PdfWriter.PdfBody.PdfCrossReference
extends Object
implements Comparable<PdfWriter.PdfBody.PdfCrossReference>

PdfCrossReference is an entry in the PDF Cross-Reference table.

Constructor Summary

Constructors

Constructor	Description
PdfCrossReference(int type, int refnum, long offset, int generation)
PdfCrossReference(int refnum, long offset)	Constructs a cross-reference element for a PdfIndirectObject.
PdfCrossReference(int refnum, long offset, int generation)	Constructs a cross-reference element for a PdfIndirectObject.

Method Summary

Modifier and Type	Method	Description
int	compareTo(PdfWriter.PdfBody.PdfCrossReference reference)	Compares current entry with passed reference by PDF object number.
boolean	equals(Object obj)	Checks if two entries are equal if their PDF object numbers are equal.
int	hashCode()
void	toPdf(int midSize, OutputStream os)	Writes PDF syntax to the OutputStream
void	toPdf(OutputStream os)	Writes PDF representation of cross-reference entry to passed output stream.

Methods inherited from class java.lang.Object

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

Constructor Details

PdfCrossReference

public PdfCrossReference(int refnum,
 long offset,
 int generation)

Constructs a cross-reference element for a PdfIndirectObject.

Parameters:

refnum - the reference number

offset - byte offset of the object

generation - generation number of the object

PdfCrossReference

public PdfCrossReference(int refnum,
 long offset)

Constructs a cross-reference element for a PdfIndirectObject.

Parameters:

refnum - the reference number

offset - byte offset of the object

PdfCrossReference

public PdfCrossReference(int type,
 int refnum,
 long offset,
 int generation)

Method Details

toPdf

public void toPdf(OutputStream os)
           throws IOException

Writes PDF representation of cross-reference entry to passed output stream.

Parameters:

os - Output stream this entry to write to

Throws:

IOException - If any I/O error occurs

toPdf

public void toPdf(int midSize,
 OutputStream os)
           throws IOException

Writes PDF syntax to the OutputStream

Parameters:

midSize - the mid size

os - the OutputStream

Throws:

IOException - on error

compareTo

public int compareTo(PdfWriter.PdfBody.PdfCrossReference reference)

Compares current entry with passed reference by PDF object number.

Specified by:

compareTo in interface Comparable<PdfWriter.PdfBody.PdfCrossReference>

equals

public boolean equals(Object obj)

Checks if two entries are equal if their PDF object numbers are equal.

Overrides:

equals in class Object

Parameters:

obj - Another cross-reference entry

Returns:

If null, not of type PdfWriter.PdfBody.PdfCrossReference or object numbers are not equal, returns false; true otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class Object