FileDocCategorySizeDatePackage
PatternSyntaxException.javaAPI DocJava SE 6 API2487Tue Jun 10 00:26:00 BST 2008java.util.regex

PatternSyntaxException

public class PatternSyntaxException extends IllegalArgumentException
Unchecked exception thrown to indicate a syntax error in a regular-expression pattern.
author
unascribed
version
1.16, 06/05/22
since
1.4
spec
JSR-51

Fields Summary
private final String
desc
private final String
pattern
private final int
index
private static final String
nl
Constructors Summary
public PatternSyntaxException(String desc, String regex, int index)
Constructs a new instance of this class.

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

	this.desc = desc;
	this.pattern = regex;
	this.index = index;
    
Methods Summary
public java.lang.StringgetDescription()
Retrieves the description of the error.

return
The description of the error

	return desc;
    
public intgetIndex()
Retrieves the error index.

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

	return index;
    
public java.lang.StringgetMessage()
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.

return
The full detail message


                                            
       
        StringBuffer sb = new StringBuffer();
        sb.append(desc);
	if (index >= 0) {
	    sb.append(" near index ");
	    sb.append(index);
	}
        sb.append(nl);
        sb.append(pattern);
	if (index >= 0) {
	    sb.append(nl);
	    for (int i = 0; i < index; i++) sb.append(' ");
	    sb.append('^");
	}
        return sb.toString();
    
public java.lang.StringgetPattern()
Retrieves the erroneous regular-expression pattern.

return
The erroneous pattern

	return pattern;