Module org.sejda.sambox

Package org.sejda.sambox.output

Class ExistingPagesSizePredictor

java.lang.Object

org.sejda.sambox.output.ExistingPagesSizePredictor

All Implemented Interfaces:

Closeable, AutoCloseable, COSVisitor

public class ExistingPagesSizePredictor
extends Object

Component that tries to predict the size of a resulting document if PDPages and COSObjectables are added to it. The component does its best to return exact predicted values and it does that by simulating an actual write, despite that, the predicted values should be considered rough estimations and not a byte precision ones.

Author:

Andrea Vacondio

Method Summary

Modifier and Type	Method	Description
void	addIndirectReferenceFor(COSObjectable value)	Adds the COSObjectable to the predicted size.
void	addPage(PDPage page)	Adds a PDPage to the predicted size.
void	close()
boolean	hasPages()
static ExistingPagesSizePredictor	instance(WriteOption... opts)	Factory method for an ExistingPagesSizePredictor
void	onPotentialIndirectObject(COSBase item)	Called during the visit on the objects graph, when a potential indirect object is met.
long	pages()
long	predictedPagesSize()
long	predictedXrefTableSize()
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

Method Details

addPage

public void addPage(PDPage page)
             throws IOException

Adds a PDPage to the predicted size. This component simulates the page write to a DevNullWritableByteChannel and does not release the page objects once written.

Parameters:

page -

Throws:

IOException

addIndirectReferenceFor

public void addIndirectReferenceFor(COSObjectable value)
                             throws IOException

Adds the COSObjectable to the predicted size. The object is added as an indirect reference and is processed, specifically, in case of COSDictionary or COSArray, indirect reference might be created for their values.

Parameters:

value -

Throws:

IOException

predictedPagesSize

public long predictedPagesSize()
                        throws IOException

Returns:

the current predicted page size

Throws:

IOException

predictedXrefTableSize

public long predictedXrefTableSize()

Returns:

the current predicted xref size

Throws:

IOException

hasPages

public boolean hasPages()

Returns:

true if some page has been written

pages

public long pages()

Returns:

the current number of written pages

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

instance

public static ExistingPagesSizePredictor instance(WriteOption... opts)

Factory method for an ExistingPagesSizePredictor

Parameters:

opts -

Returns:

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

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

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