Package org.apache.juneau.marshall.parser

Class ParseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.juneau.commons.BasicRuntimeException

org.apache.juneau.marshall.BasicRuntimeException

org.apache.juneau.marshall.parser.ParseException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MissingRequiredPropertyException

public class ParseException
extends BasicRuntimeException

Exception that indicates invalid syntax encountered during parsing.

See Also:

• Serializers and Parsers

Constructor Summary

Constructors

Constructor	Description
ParseException(String message, Object... args)	Constructor.
ParseException(Throwable causedBy)	Constructor.
ParseException(Throwable causedBy, String message, Object... args)	Constructor.
ParseException(ParserSession session, Exception causedBy)	Constructor.
ParseException(ParserSession session, String message, Object... args)	Constructor.
ParseException(ParserSession session, Throwable causedBy, String message, Object... args)	Constructor.

Method Summary

Modifier and Type	Method	Description
static ParseException	create(Throwable e)	Creator method.
ParseException	getRootCause()	Returns the highest-level ParseException in the stack trace.
ParseException	setMessage(String message, Object... args)	Sets the detail message on this exception.

Methods inherited from class org.apache.juneau.commons.BasicRuntimeException

getMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

Constructor Details

ParseException

public ParseException(ParserSession session,
 Exception causedBy)

Constructor.

Parameters:

session - The parser session.
Can be null (the message is not augmented with position/debug info).

causedBy - The inner exception.
Must not be null.

ParseException

public ParseException(ParserSession session,
 String message,
 Object... args)

Constructor.

Parameters:

session - The parser session.
Can be null (the message is not augmented with position/debug info).

message - The exception message containing String.format-style (%s) arguments.

args - Optional String.format-style arguments.

ParseException

public ParseException(ParserSession session,
 Throwable causedBy,
 String message,
 Object... args)

Constructor.

Parameters:

session - The parser session.
Can be null (the message is not augmented with position/debug info).

causedBy - The cause of this exception.
Can be null (no cause is set).

message - The exception message containing String.format-style (%s) arguments.

args - Optional String.format-style arguments.

ParseException

public ParseException(String message,
 Object... args)

Constructor.

Parameters:

message - The String.format-style message (%s placeholders).

args - Optional String.format-style arguments.

ParseException

public ParseException(Throwable causedBy)

Constructor.

Parameters:

causedBy - The cause of this exception.
Can be null (no cause is set).

ParseException

public ParseException(Throwable causedBy,
 String message,
 Object... args)

Constructor.

Parameters:

causedBy - The cause of this exception.
Can be null (no cause is set).

message - The String.format-style message (%s placeholders).

args - Optional String.format-style arguments.

Method Details

create

public static ParseException create(Throwable e)

Creator method.

If the throwable is already a ParseException, we simply return that exception as-is. If the throwable is an InvocationTargetException, we unwrap the thrown exception. Otherwise we create a new ParseException.

Parameters:

e - The exception being wrapped or unwrapped.
Can be null (a new ParseException with no cause is created).

Returns:

The specified throwable wrapped or unwrapped as a ParseException (may be the same instance if it already was one).

getRootCause

public ParseException getRootCause()

Returns the highest-level ParseException in the stack trace.

Useful for JUnit testing of error conditions.

Returns:

The root parse exception, or this exception if there isn't one.

setMessage

public ParseException setMessage(String message,
 Object... args)

Description copied from class: BasicRuntimeException

Sets the detail message on this exception.

Overrides:

setMessage in class BasicRuntimeException

Parameters:

message - The message.

args - The message args.

Returns:

This object.