com.datalogics.PDFL

Class LibraryException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.datalogics.PDFL.LibraryException

All Implemented Interfaces:

java.io.Serializable

public class LibraryException
extends java.lang.RuntimeException

Exception thrown when there is an error processing a Library call.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LibraryException(java.lang.String message, int errorCode, java.lang.String objectName, java.lang.String additionalInfo) Exception thrown when there is an error processing a Library call.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdditionalInfo() Retrieve additional information about the exception.
int	getErrorCode() Retrieve the internal PDF Library error code.
java.lang.String	getObjectName() Retrieve the name of the object that caused the exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LibraryException

public LibraryException(java.lang.String message,
                        int errorCode,
                        java.lang.String objectName,
                        java.lang.String additionalInfo)

Exception thrown when there is an error processing a Library call.

Parameters:

message - The detail message.

errorCode - The PDF Library error code.

objectName - The name of the object (i.e. a filename for a file) that caused the error.

additionalInfo - A string containing additional information about the object.

Method Detail

getErrorCode

public int getErrorCode()

Retrieve the internal PDF Library error code.

Returns:

The error code for this exception.

getObjectName

public java.lang.String getObjectName()

Retrieve the name of the object that caused the exception.

Returns:

The name of the object.

getAdditionalInfo

public java.lang.String getAdditionalInfo()

Retrieve additional information about the exception.

Returns:

A string containing additional information about the exception.