org.wso2.charon3.core.aParser

Class ParserException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.wso2.charon3.core.aParser.ParserException

All Implemented Interfaces:

Serializable

public class ParserException
extends Exception

Signals that a parse failure has occurred.

Producer : com.parse2.aparse.Parser 2.5
Produced : Mon Jul 15 14:23:14 IST 2019

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParserException(String reason, String text, int index, Stack<String> ruleStack) Creates a parser exception from the specified parse failure information.

Method Summary

Modifier and Type	Method and Description
String	getMessage() Returns a message detailing the parse failure.
String	getReason() Returns the description of the parse failure.
Stack<String>	getRuleStack() Returns the ABNF rule stack at the point the parse failure occurred.
String	getSubstring() Returns a substring of the parsed string that encompasses the point at which the parse failure occurred.
int	getSubstringIndex() Returns an index to the character within the substring returned by getSubstring() at which the parse failure occurred.

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 Detail

ParserException

public ParserException(String reason,
                       String text,
                       int index,
                       Stack<String> ruleStack)

Creates a parser exception from the specified parse failure information.

Parameters:

reason - A description of the parse failure.

text - The string of characters being parsed.

index - The index to the character at which the parse failure occurred.

ruleStack - The ABNF rule stack at the point the parse failure occurred.

Method Detail

getReason

public String getReason()

Returns the description of the parse failure.

Returns:

The description of the parse failure.

getSubstring

public String getSubstring()

Returns a substring of the parsed string that encompasses the point at which the parse failure occurred. The substring will be up to 60 characters in length unless the point of failure occurred within 30 characters of the start or end of the parsed string. getSubstringIndex() returns an index to the character within this substring at which the parse failure occurred. This substring may contain non-printable characters.

Returns:

The substring that encompasses the point of failure.

getSubstringIndex

public int getSubstringIndex()

Returns an index to the character within the substring returned by getSubstring() at which the parse failure occurred.

Returns:

The index to the character within the substring returned getSubstring() at which the parse failure occurred.

getRuleStack

public Stack<String> getRuleStack()

Returns the ABNF rule stack at the point the parse failure occurred.

Returns:

The ABNF rule stack.

getMessage

public String getMessage()

Returns a message detailing the parse failure. The message detail the reason for the failure and where the failure occurred.

For example ...

rule "Minutes" failed
15:75:47
^
rule stack:
Clock
Minutes

Overrides:

getMessage in class Throwable

Returns:

Details of the parse failure.