This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

java.util.regex
exception PatternSyntaxException

java.lang.Object extended by java.lang.Throwable extended by java.lang.Exception extended by java.lang.RuntimeException extended by java.lang.IllegalArgumentException extended by java.util.regex.PatternSyntaxException
All Implemented Interfaces:
Serializable
public exception PatternSyntaxException
extends IllegalArgumentException

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

Constructor Summary
PatternSyntaxException(String desc, String regex, int index)

          Constructs a new instance of this class.
 
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.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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 Detail

getDescription

public String getDescription()
Retrieves the description of the error.

Returns:
The description of the error

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

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

getPattern

public String getPattern()
Retrieves the erroneous regular-expression pattern.

Returns:
The erroneous pattern
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.