Module org.sejda.sambox

Package org.sejda.sambox.output

Class PDFBodyWriter

java.lang.Object

org.sejda.sambox.output.PDFBodyWriter

All Implemented Interfaces:

Closeable, AutoCloseable, COSVisitor

Direct Known Subclasses:

ExistingPagesSizePredictor, IncrementalPDFBodyWriter

class PDFBodyWriter
extends Object
implements COSVisitor, Closeable

Base component providing methods to write the body of a pdf document. This implementation starts from the document trailer and visits the whole document graph updating the PDFWriteContext. An IndirectCOSObjectReference is created by the context for each COSDictionary and ExistingIndirectCOSObject, if not previously created. Once all the values of a COSDictionary or COSArray have been explored, the COSDictionary/ COSArray is written as a pdf object, this allows an async implementation to write objects while the body writer is still performing its algorithm.

Field Summary

Fields

Modifier and Type	Field	Description
private PDFWriteContext	context
(package private) PDFBodyObjectsWriter	objectsWriter
private boolean	open
private Queue<IndirectCOSObjectReference>	stack

Constructor Summary

Constructors

Constructor	Description
PDFBodyWriter(PDFWriteContext context, PDFBodyObjectsWriter objectsWriter)

Method Summary

Modifier and Type	Method	Description
void	close()
(package private) PDFWriteContext	context()
(package private) final void	createIndirectReferenceIfNeededFor(COSBase item)
void	onPotentialIndirectObject(COSBase item)	Called during the visit on the objects graph, when a potential indirect object is met.
private boolean	shouldBeIndirect(COSBase item)
(package private) void	startWriting()	Starts writing whatever has been stacked
void	visit(COSArray array)
void	visit(COSDictionary value)
void	visit(COSDocument document)
void	visit(COSStream value)
void	write(COSDocument document)	Writes the body of the given document
void	write(IncrementablePDDocument document)	Writes the given document

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sejda.sambox.cos.COSVisitor

visit, visit, visit, visit, visit, visit, visit

Field Details

stack

private Queue<IndirectCOSObjectReference> stack

context

private PDFWriteContext context

open

private boolean open

objectsWriter

PDFBodyObjectsWriter objectsWriter

Constructor Details

PDFBodyWriter

PDFBodyWriter(PDFWriteContext context,
 PDFBodyObjectsWriter objectsWriter)

Method Details

context

PDFWriteContext context()

write

public void write(IncrementablePDDocument document)
           throws IOException

Writes the given document

Parameters:

document -

Throws:

IOException

write

public void write(COSDocument document)
           throws IOException

Writes the body of the given document

Parameters:

document -

Throws:

IOException

visit

public void visit(COSDocument document)
           throws IOException

Specified by:

visit in interface COSVisitor

Throws:

IOException

startWriting

void startWriting()
           throws IOException

Starts writing whatever has been stacked

Throws:

IOException

visit

public void visit(COSArray array)
           throws IOException

Specified by:

visit in interface COSVisitor

Throws:

IOException

visit

public void visit(COSDictionary value)
           throws IOException

Specified by:

visit in interface COSVisitor

Throws:

IOException

visit

public void visit(COSStream value)
           throws IOException

Specified by:

visit in interface COSVisitor

Throws:

IOException

shouldBeIndirect

private boolean shouldBeIndirect(COSBase item)

onPotentialIndirectObject

public void onPotentialIndirectObject(COSBase item)
                               throws IOException

Called during the visit on the objects graph, when a potential indirect object is met. Default implementation creates a new indirect reference for it.

Parameters:

item -

Throws:

IOException

createIndirectReferenceIfNeededFor

final void createIndirectReferenceIfNeededFor(COSBase item)

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException