Class PatternSyntaxException

java.util.regex.PatternSyntaxException

All Implemented Interfaces:: Serializable

public class PatternSyntaxException extends IllegalArgumentException

Unchecked exception thrown to indicate a syntax error in a regular-expression pattern.

Since:

1.4

See Also:

Constructor Summary

Constructor	Description
`PatternSyntaxException(String desc, String regex, int index)`	Constructs a new instance of this class.

Method Summary

Modifier and Type	Method	Description
`String`	`getDescription()`	Retrieves the description of the error.
`int`	`getIndex()`	Retrieves the error index.
`String`	`getMessage()`	Returns a multi-line string containing the description of the syntax error and its index, the erroneous regular-expression pattern, and a visual indication of the error index within the pattern.
`String`	`getPattern()`	Retrieves the erroneous regular-expression pattern.

Methods declared in class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods declared in class Object

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

Constructor Details

PatternSyntaxException

public PatternSyntaxException(String desc, String regex, int index)

Constructs a new instance of this class.

Parameters:: desc - A description of the error; regex - The erroneous pattern; index - The approximate index in the pattern of the error, or -1 if the index is not known

Method Details

getIndex

public int getIndex()

Retrieves the error index.

Returns:: The approximate index in the pattern of the error, or -1 if the index is not known

getDescription

public String getDescription()

Retrieves the description of the error.

Returns:: The description of the error

getPattern

public String getPattern()

Retrieves the erroneous regular-expression pattern.

Returns:: The erroneous pattern

getMessage

public String getMessage()

Returns a multi-line string containing the description of the syntax error and its index, the erroneous regular-expression pattern, and a visual indication of the error index within the pattern.

Overrides:: getMessage in class Throwable
Returns:: The full detail message

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/util/regex/PatternSyntaxException.html