com.realobjects.pdfreactor

Class Result

java.lang.Object

com.realobjects.pdfreactor.Result

public class Result
extends Object

The Result class represents the result of a PDFreactor conversion.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getDocument() Returns the converted PDF or image.
byte[][]	getDocumentArray() Returns the converted multi-page image, only if Configuration#setMultiPage(Boolean) was set to true and Configuration#setOutputFormat(Configuration.Output) was set to an image format, otherwise it returns null.
ExceedingContent[]	getExceedingContents() Provides information about content exceeding its page or parent.
Log	getLog() Returns the Log of the conversion.
int	getNumberOfPages() Returns the number of pages of the laid out input document after conversion.
int	getNumberOfPagesLiteral() Returns the number of pages of the resulting PDF.

Methods inherited from class java.lang.Object

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

Method Detail

getDocument

public byte[] getDocument()

Returns the converted PDF or image.

If the conversion was not successful or if the resulting PDF or image has been written directly into an OutputStream via the PDFreactor.convert(Configuration, OutputStream)s method, this returns null.

getDocumentArray

public byte[][] getDocumentArray()

Returns the converted multi-page image, only if Configuration#setMultiPage(Boolean) was set to true and Configuration#setOutputFormat(Configuration.Output) was set to an image format, otherwise it returns null.

getNumberOfPages

public int getNumberOfPages()

Returns the number of pages of the laid out input document after conversion.

getNumberOfPagesLiteral

public int getNumberOfPagesLiteral()

Returns the number of pages of the resulting PDF. Contrary to Result.getNumberOfPages(), this method takes merge operations into account and returns the literal number of pages of the resulting PDF.

getLog

public Log getLog()

Returns the Log of the conversion. The log only has content if an appropriate PDFreactor.LogLevel was set.

getExceedingContents

public ExceedingContent[] getExceedingContents()

Provides information about content exceeding its page or parent. Depends on the mode set via Configuration.setLogExceedingContent(Configuration.LogExceedingContent).

Returns:

an array of ExceedingContent objects or null if the logging of exceeding content was not enabled .