public class Result extends Object
The Result
class represents the result of a PDFreactor
conversion.
Modifier and Type | Method and Description |
---|---|
Connection[] |
getConnections()
Provides a log about all URL connections attempted by PDFreactor, including information about
HTTP request and result, should the connection be an HTTP or HTTPS connection.
|
String |
getConversionName()
Returns the name of the conversion if it was specified via
Configuration.setConversionName(String) . |
byte[] |
getDocument()
Returns the converted PDF or image.
|
byte[][] |
getDocumentArray()
Returns the converted multi-page image, only if
Configuration.OutputFormat.setMultiImage(Boolean) was set to true
and Configuration.setOutputFormat(com.realobjects.pdfreactor.Configuration.OutputFormat) was set to an image format,
otherwise it returns null . |
ExceedingContent[] |
getExceedingContents()
Provides information about content exceeding its page or parent.
|
String |
getJavaScriptExports()
Returns data that has been exported from document JavaScript via
ro.exports if set,
null otherwise. |
Log |
getLog()
Returns the
Log of the conversion. |
MissingResource[] |
getMissingResources()
Provides information about resources that could not be loaded during 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.
|
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
.
public byte[][] getDocumentArray()
Returns the converted multi-page image, only if Configuration.OutputFormat.setMultiImage(Boolean)
was set to true
and Configuration.setOutputFormat(com.realobjects.pdfreactor.Configuration.OutputFormat)
was set to an image format,
otherwise it returns null
.
public int getNumberOfPages()
Returns the number of pages of the laid out input document after conversion.
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.
public Log getLog()
Returns the Log
of the conversion. The log only has content if an appropriate PDFreactorLegacy.LogLevel
was
set.
public ExceedingContent[] getExceedingContents()
Provides information about content exceeding its page or parent.
Depends on the mode set via Configuration.setContentObserver(Configuration.ContentObserver)
.
ExceedingContent
objects
or null
if the logging of exceeding content was not enabled or no content exceeded its page or parent.public MissingResource[] getMissingResources()
Provides information about resources that could not be loaded during the conversion.
Depends on the mode set via Configuration.setContentObserver(Configuration.ContentObserver)
.
MissingResource
objects or null
if the logging of missing
resources was not enabled or no resources were missing.public Connection[] getConnections()
Provides a log about all URL connections attempted by PDFreactor, including information about
HTTP request and result, should the connection be an HTTP or HTTPS connection.
Depends on the mode set via Configuration.setContentObserver(Configuration.ContentObserver)
.
Connection
objects or null
if the logging of connections
was not enabled or no connections were attempted.public String getConversionName()
Returns the name of the conversion if it was specified via Configuration.setConversionName(String)
.
public String getJavaScriptExports()
Returns data that has been exported from document JavaScript via ro.exports
if set,
null
otherwise. If the JavaScript data is not a string, it will be converted to JSON.
If the data can't be converted, a generic string representation is used or null
if none is
available.
This doc was generated on 2024-06-12. Copyright © 2002-2024 RealObjects GmbH. All Rights Reserved.