org.apache.pdfbox.preflight.exception

Class PdfParseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.pdfbox.preflight.javacc.ParseException

org.apache.pdfbox.preflight.exception.PdfParseException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BodyParseException, CrossRefParseException, HeaderParseException, TrailerParseException

public class PdfParseException
extends ParseException

A PdfParseException is thrown when the JavaCC Parser can't validate the pdf file. In this case a PdfParseException (or an inherited class) is thrown. A PdfParseException inherits from ParseException to avoid compilation errors in the classes generated by JavaCC.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	errorCode
protected boolean	isTokenMgrError
protected int	line

Fields inherited from class org.apache.pdfbox.preflight.javacc.ParseException

currentToken, EOL, expectedTokenSequences, tokenImage

Constructor Summary

Constructors

Constructor and Description
PdfParseException(ParseException e) This constructor clones the given ParseException and initialize the errorCode if it is possible.
PdfParseException(String message) This constructor calls the PdfParseException(String message, String code) constructor with a code set to null.
PdfParseException(String message, String code) This constructor is generally used when the PDF validation fails due to a TokenMngError.

Method Summary

Modifier and Type	Method and Description
String	getErrorCode() Get the validation error code

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

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

Field Detail

isTokenMgrError

protected boolean isTokenMgrError

errorCode

protected String errorCode

line

protected int line

Constructor Detail

PdfParseException

public PdfParseException(ParseException e)

This constructor clones the given ParseException and initialize the errorCode if it is possible. (e is an instance of PdfParseException)

Parameters:

e -

PdfParseException

public PdfParseException(String message)

This constructor calls the PdfParseException(String message, String code) constructor with a code set to null.

Parameters:

message - the explanation message (The message of TokenMngError). This field is mandatory.

PdfParseException

public PdfParseException(String message,
                         String code)

This constructor is generally used when the PDF validation fails due to a TokenMngError. In this case, the message should be the message of the TokenMngError.

Parameters:

message - the explanation message (The message of TokenMngError). This field is mandatory.

code - the error code if it can be determined by the creator of this exception (Can be null)

Method Detail

getErrorCode

public String getErrorCode()

Get the validation error code

Returns: