Module org.sejda.sambox

Package org.sejda.sambox.output

Class ExistingPagesSizePredictor

java.lang.Object

org.sejda.sambox.output.PDFBodyWriter

org.sejda.sambox.output.ExistingPagesSizePredictor

All Implemented Interfaces:

Closeable, AutoCloseable, COSVisitor

public class ExistingPagesSizePredictor
extends PDFBodyWriter

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ExistingPagesSizePredictor.BodyObjectsWriter

Field Summary

Fields

Modifier and Type	Field	Description
private final org.sejda.io.CountingWritableByteChannel	channel
private static final org.slf4j.Logger	LOG
private long	pages
private static final int	STREAM_WRAPPING_SIZE
private final IndirectObjectsWriter	writer

Fields inherited from class org.sejda.sambox.output.PDFBodyWriter

objectsWriter

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ExistingPagesSizePredictor(PDFWriteContext context, IndirectObjectsWriter writer, org.sejda.io.CountingWritableByteChannel channel)

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
long	pages()
long	predictedPagesSize()
long	predictedXrefTableSize()

Methods inherited from class org.sejda.sambox.output.PDFBodyWriter

context, createIndirectReferenceIfNeededFor, onPotentialIndirectObject, startWriting, visit, visit, visit, visit, write, write

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

LOG

private static final org.slf4j.Logger LOG

STREAM_WRAPPING_SIZE

private static final int STREAM_WRAPPING_SIZE

See Also:

• Constant Field Values

channel

private final org.sejda.io.CountingWritableByteChannel channel

writer

private final IndirectObjectsWriter writer

pages

private long pages

Constructor Details

ExistingPagesSizePredictor

private ExistingPagesSizePredictor(PDFWriteContext context,
 IndirectObjectsWriter writer,
 org.sejda.io.CountingWritableByteChannel channel)

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

Overrides:

close in class PDFBodyWriter

Throws:

IOException

instance

public static ExistingPagesSizePredictor instance(WriteOption... opts)

Factory method for an ExistingPagesSizePredictor

Parameters:

opts -

Returns: