Package com.lowagie.text.pdf
Class PdfWriter.PdfBody.PdfCrossReference
java.lang.Object
com.lowagie.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.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
String template for cross-reference entry PDF representation.private final int
generation of the object.private final long
Byte offset in the PDF file.private final int
private final int
-
Constructor Summary
ConstructorsConstructorDescriptionPdfCrossReference
(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 TypeMethodDescriptionint
compareTo
(PdfWriter.PdfBody.PdfCrossReference reference) Compares currententry
with passedreference
by PDF object number.boolean
Checks if two entries are equal if their PDF object numbers are equal.(package private) int
int
hashCode()
void
toPdf
(int midSize, OutputStream os) Writes PDF syntax to the OutputStreamvoid
toPdf
(OutputStream os) Writes PDF representation of cross-reference entry to passed output stream.
-
Field Details
-
CROSS_REFERENCE_ENTRY_FORMAT
String template for cross-reference entry PDF representation.- See Also:
-
type
private final int type -
offset
private final long offsetByte offset in the PDF file. -
refnum
private final int refnum -
generation
private final int generationgeneration of the object.
-
-
Constructor Details
-
PdfCrossReference
public PdfCrossReference(int refnum, long offset, int generation) Constructs a cross-reference element for a PdfIndirectObject.- Parameters:
refnum
- the reference numberoffset
- byte offset of the objectgeneration
- generation number of the object
-
PdfCrossReference
public PdfCrossReference(int refnum, long offset) Constructs a cross-reference element for a PdfIndirectObject.- Parameters:
refnum
- the reference numberoffset
- byte offset of the object
-
PdfCrossReference
public PdfCrossReference(int type, int refnum, long offset, int generation)
-
-
Method Details
-
getRefnum
int getRefnum() -
toPdf
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
Writes PDF syntax to the OutputStream- Parameters:
midSize
- the mid sizeos
- the OutputStream- Throws:
IOException
- on error
-
compareTo
Compares currententry
with passedreference
by PDF object number.- Specified by:
compareTo
in interfaceComparable<PdfWriter.PdfBody.PdfCrossReference>
-
equals
Checks if two entries are equal if their PDF object numbers are equal.- Overrides:
equals
in classObject
- 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()
-