PatternSyntaxException

AI-generated Key Takeaways

• PatternSyntaxException signals syntax errors in regular expression patterns.

• It's an unchecked exception, meaning it's not required to be explicitly caught.

• Provides methods to retrieve error descriptions, the problematic pattern, and the error's location within the pattern.

• Inherits functionality from IllegalArgumentException and Throwable for exception handling.

public class PatternSyntaxException extends IllegalArgumentException

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

Public Constructor Summary

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

Public Method Summary

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.

Inherited Method Summary

From class java.lang.Throwable

synchronized final void	addSuppressed(Throwable exception) Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
synchronized Throwable	fillInStackTrace() Fills in the execution stack trace.
synchronized Throwable	getCause() Returns the cause of this throwable or null if the cause is nonexistent or unknown.
String	getLocalizedMessage() Creates a localized description of this throwable.
String	getMessage() Returns the detail message string of this throwable.
StackTraceElement[]	getStackTrace() Provides programmatic access to the stack trace information printed by printStackTrace().
synchronized final Throwable[]	getSuppressed() Returns an array containing all of the exceptions that were suppressed, typically by the try-with-resources statement, in order to deliver this exception.
synchronized Throwable	initCause(Throwable cause) Initializes the cause of this throwable to the specified value.
void	printStackTrace() Prints this throwable and its backtrace to the standard error stream.
void	printStackTrace(PrintWriter s) Prints this throwable and its backtrace to the specified print writer.
void	printStackTrace(PrintStream s) Prints this throwable and its backtrace to the specified print stream.
void	setStackTrace(StackTraceElement[] stackTrace) Sets the stack trace elements that will be returned by getStackTrace() and printed by printStackTrace() and related methods.
String	toString() Returns a short description of this throwable.

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

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

Public Methods

public String getDescription ()

Retrieves the description of the error.

Returns

• The description of the error

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

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.

Returns

• The full detail message

public String getPattern ()

Retrieves the erroneous regular-expression pattern.

Returns

• The erroneous pattern