Added in API level 1

PatternSyntaxException

public class PatternSyntaxException
extends IllegalArgumentException

java.lang.Object
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ java.lang.RuntimeException
         ↳ java.lang.IllegalArgumentException
           ↳ java.util.regex.PatternSyntaxException


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

Summary

Public constructors

PatternSyntaxException(String desc, String regex, int index)

Constructs a new instance of this class.

Public methods

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 methods

final void addSuppressed(Throwable exception)

Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.

Throwable fillInStackTrace()

Fills in the execution stack trace.

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().

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.

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.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

PatternSyntaxException

Added in API level 1
public PatternSyntaxException (String desc, 
                String regex, 
                int index)

Constructs a new instance of this class.

Parameters
desc String: A description of the error

regex String: The erroneous pattern

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

Public methods

getDescription

Added in API level 1
public String getDescription ()

Retrieves the description of the error.

Returns
String The description of the error

getIndex

Added in API level 1
public int getIndex ()

Retrieves the error index.

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

getMessage

Added in API level 1
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
String The full detail message

getPattern

Added in API level 1
public String getPattern ()

Retrieves the erroneous regular-expression pattern.

Returns
String The erroneous pattern