Package java.util.regex

Class PatternSyntaxException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

java.util.regex.PatternSyntaxException

All Implemented Interfaces:

Serializable

public class PatternSyntaxException
extends IllegalArgumentException

Encapsulates a syntax error that occurred during the compilation of a Pattern. Might include a detailed description, the original regular expression, and the index at which the error occurred.

See Also:

Pattern.compile(String), Pattern.compile(java.lang.String,int), Serialized Form

Constructor Summary

Constructors

Constructor	Description
PatternSyntaxException(String description, String pattern, int index)	Creates a new PatternSyntaxException for a given message, pattern, and error index.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns the description of the syntax error, or null if the description is not known.
int	getIndex()	Returns the character index around which the error occurred, or -1 if the index is not known.
String	getMessage()	Returns a detailed error message for the exception.
String	getPattern()	Returns the syntactically incorrect regular expression.

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

PatternSyntaxException

public PatternSyntaxException(String description,
String pattern,
int index)

Creates a new PatternSyntaxException for a given message, pattern, and error index.

Parameters:

description - the description of the syntax error, or null if the description is not known.

pattern - the syntactically incorrect regular expression, or null if the regular expression is not known.

index - the character index around which the error occurred, or -1 if the index is not known.

Method Details

getPattern

public String getPattern()

Returns the syntactically incorrect regular expression.

Returns:

the regular expression.

getMessage

public String getMessage()

Returns a detailed error message for the exception. The message is potentially multi-line, and it might include a detailed description, the original regular expression, and the index at which the error occurred.

Overrides:

getMessage in class Throwable

Returns:

the error message.

getDescription

public String getDescription()

Returns the description of the syntax error, or null if the description is not known.

Returns:

the description.

getIndex

public int getIndex()

Returns the character index around which the error occurred, or -1 if the index is not known.

Returns:

the index.