Summary: Constants | Ctors | Methods | Inherited Methods | [Expand All]
public class

# PDFNetException

extends Exception

java.lang.Object
↳ | java.lang.Throwable
| ↳ | java.lang.Exception
|  | ↳ | com.pdftron.common.PDFNetException

## Class Overview

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.

## Summary

Constants
long | e_error_credentials |
long | e_error_general |
long | e_error_network |
long | e_error_num |

Public Constructors
| PDFNetException(String cond_expr, long line_number, String file_name, String function, String message) Instantiates a new PDFNetException.
| PDFNetException(String cond_expr, long line_number, String file_name, String function, String message, long error_code) Instantiates a new PDFNetException.

Public Methods
String | getCondExpr() Get the conditional expression that caused the exception
long | getErrorCode() Get the line number indicating where the exception occurred.
String | getFileName() Get the filename indicating where the exception occurred.
String | getFunction() Get the function name where the exception occurred.
int | getLineNumber() Get the line number indicating where the exception occurred.
String | getMessage() Get the detailed error message.
String | toString() String representation of PDFNetException object

[Expand] Inherited Methods
From class java.lang.Throwable
synchronized final void | addSuppressed(Throwable arg0)
synchronized Throwable | fillInStackTrace()
synchronized Throwable | getCause()
String | getLocalizedMessage()
String | getMessage()
StackTraceElement[] | getStackTrace()
synchronized final Throwable[] | getSuppressed()
synchronized Throwable | initCause(Throwable arg0)
void | printStackTrace()
void | printStackTrace(PrintWriter arg0)
void | printStackTrace(PrintStream arg0)
void | setStackTrace(StackTraceElement[] arg0)
String | toString()
From class java.lang.Object
boolean | equals(Object arg0)
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()

## Constants

#### public static final long e_error_credentials

Constant Value: 2 (0x0000000000000002)

#### public static final long e_error_general

Constant Value: 0 (0x0000000000000000)

#### public static final long e_error_network

Constant Value: 1 (0x0000000000000001)

#### public static final long e_error_num

Constant Value: 3 (0x0000000000000003)

## Public Constructors

#### public PDFNetException (String cond_expr, long line_number, String file_name, String function, 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.

#### public PDFNetException (String cond_expr, long line_number, String file_name, String function, String message, long error_code)

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.
error_code | the type of exception.

## Public Methods

#### public String getCondExpr ()

Get the conditional expression that caused the exception

##### Returns

- the conditional expression that caused the exception

#### public long getErrorCode ()

Get the line number indicating where the exception occurred.

##### Returns

- the error code of this Exception object.

#### public String getFileName ()

Get the filename indicating where the exception occurred.

##### Returns

- the filename indicating where the exception occurred

#### public String getFunction ()

Get the function name where the exception occurred.

##### Returns

- the function name where the exception occurred

#### public int getLineNumber ()

Get the line number indicating where the exception occurred.

##### Returns

- the line number indicating where the exception occurred

#### public String getMessage ()

Get the detailed error message.

##### Returns

- the error message string of this Exception object.

#### public String toString ()

String representation of PDFNetException object

##### Returns

- a short description of this Exception object.