Package com.realobjects.pdfreactor

Class Configuration.DebugSettings

java.lang.Object

com.realobjects.pdfreactor.Configuration.DebugSettings

Enclosing class:

Configuration

public static final class Configuration.DebugSettings
extends Object

A type containing various options for debugging.

Constructor Summary

Constructors

Constructor	Description
DebugSettings()

Method Summary

Modifier and Type	Method	Description
Configuration.DebugSettings	setAll(Boolean all)	This is a convenience property that enables the following Configuration.DebugSettings:
Configuration.DebugSettings	setAppendLogs(Boolean appendLogs)	Specifies whether the logs will be appended to the resulting PDF.
Configuration.DebugSettings	setAttachConfiguration(Boolean attachConfiguration)	Specifies whether the configuration will be attached to the generated PDF.
Configuration.DebugSettings	setAttachDocuments(Boolean attachDocuments)	Specifies whether all debug files belonging to the group "documents" will be attached to the generated PDF.
Configuration.DebugSettings	setAttachLogs(Boolean attachLogs)	Specifies whether all debug files belonging to the group "logs" will be attached to the generated PDF.
Configuration.DebugSettings	setAttachResources(Boolean attachResources)	Specifies whether all debug files belonging to the group "resources" will be attached to the generated PDF.
Configuration.DebugSettings	setForceResult(Boolean forceResult)	Forces PDFreactor to return a result, regardless of any exceptions or errors that may have occurred during the conversion.
Configuration.DebugSettings	setLocalDirectory(Path localDirectory)	Specifies a local directory where PDFreactor will dump debug files in case an exception occurs during conversion.

Methods inherited from class java.lang.Object

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

Constructor Details

DebugSettings

public DebugSettings()

Method Details

setAll

public Configuration.DebugSettings setAll(Boolean all)

This is a convenience property that enables the following Configuration.DebugSettings:

• setAttachDocuments(Boolean),
• setAttachResources(Boolean),
• setAttachLogs(Boolean),
• setAppendLogs(Boolean),
• setForceResult(Boolean)

Returns:

The current Configuration.DebugSettings instance.

setLocalDirectory

public Configuration.DebugSettings setLocalDirectory(Path localDirectory)

Specifies a local directory where PDFreactor will dump debug files in case an exception occurs during conversion.

Returns:

The current Configuration.DebugSettings instance.

setAttachConfiguration

public Configuration.DebugSettings setAttachConfiguration(Boolean attachConfiguration)

Specifies whether the configuration will be attached to the generated PDF.

Returns:

The current Configuration.DebugSettings instance.

setAttachDocuments

public Configuration.DebugSettings setAttachDocuments(Boolean attachDocuments)

Specifies whether all debug files belonging to the group "documents" will be attached to the generated PDF. Please see the manual for more information.

Returns:

The current Configuration.DebugSettings instance.

setAttachResources

public Configuration.DebugSettings setAttachResources(Boolean attachResources)

Specifies whether all debug files belonging to the group "resources" will be attached to the generated PDF. Please see the manual for more information.

Returns:

The current Configuration.DebugSettings instance.

setAttachLogs

public Configuration.DebugSettings setAttachLogs(Boolean attachLogs)

Specifies whether all debug files belonging to the group "logs" will be attached to the generated PDF. Please see the manual for more information.

Returns:

The current Configuration.DebugSettings instance.

setAppendLogs

public Configuration.DebugSettings setAppendLogs(Boolean appendLogs)

Specifies whether the logs will be appended to the resulting PDF.

Returns:

The current Configuration.DebugSettings instance.

setForceResult

public Configuration.DebugSettings setForceResult(Boolean forceResult)

Forces PDFreactor to return a result, regardless of any exceptions or errors that may have occurred during the conversion.

If an exception or error occurred during the conversion, its stack trace and the PDFreactor log is written as-is into the result data stream. This means that the resulting document will not be a valid PDF but can be opened with an appropriate text editor to view the log and errors.

Returns:

The current Configuration.DebugSettings instance.