pdftron.Common

Class PDFNetException

java.lang.Object

java.lang.Throwable

java.lang.Exception

pdftron.Common.PDFNetException

All Implemented Interfaces:

java.io.Serializable

public class PDFNetException
extends java.lang.Exception

PDFNetException is derived from the standard exception class and it is a superclass for all PDFNet library exceptions. PDFNetException and its subclasses have two constructors: one that takes no arguments and one that takes a string argument that can be used to report an error message.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	cond_expr The cond_expr.
protected java.lang.String	file_name The file_name.
protected java.lang.String	function The function.
protected long	line_number The line_number.
protected java.lang.String	message The message.

Constructor Summary

Constructors

Constructor and Description
PDFNetException(java.lang.String cond_expr, long line_number, java.lang.String file_name, java.lang.String function, java.lang.String message) Instantiates a new PDFNetException.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCondExpr() Get the conditional expression that caused the exception
java.lang.String	getFileName() Get the filename indicating where the exception occurred.
java.lang.String	getFunction() Get the function name where the exception occurred.
int	getLineNumber() Get the line number indicating where the exception occurred.
java.lang.String	getMessage() Get the detailed error message.
java.lang.String	toString() String representation of PDFNetException object

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

cond_expr

protected java.lang.String cond_expr

The cond_expr.

file_name

protected java.lang.String file_name

The file_name.

line_number

protected long line_number

The line_number.

function

protected java.lang.String function

The function.

message

protected java.lang.String message

The message.

Constructor Detail

PDFNetException

public PDFNetException(java.lang.String cond_expr,
               long line_number,
               java.lang.String file_name,
               java.lang.String function,
               java.lang.String message)

Instantiates a new PDFNetException.

Parameters:

cond_expr, - conditional expression that failed.

line_number, - the line number where the exception occurred

file_name, - the file name where the exception occurred

function, - the function in which the exception occurred

message, - the detailed error message.

Method Detail

getCondExpr

public java.lang.String getCondExpr()

Get the conditional expression that caused the exception

Returns:

the conditional expression that caused the exception

getFileName

public java.lang.String getFileName()

Get the filename indicating where the exception occurred.

Returns:

the filename indicating where the exception occurred

getLineNumber

public int getLineNumber()

Get the line number indicating where the exception occurred.

Returns:

the line number indicating where the exception occurred

getFunction

public java.lang.String getFunction()

Get the function name where the exception occurred.

Returns:

the function name where the exception occurred

getMessage

public java.lang.String getMessage()

Get the detailed error message.

Overrides:

getMessage in class java.lang.Throwable

Returns:

the error message string of this Exception object.

toString

public java.lang.String toString()

String representation of PDFNetException object

Overrides:

toString in class java.lang.Throwable

Returns:

a short description of this Exception object.