PatternSyntaxException (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • java.lang.Throwable
  • • java.lang.Exception
      • • java.lang.RuntimeException
          * * java.lang.IllegalArgumentException
          * * 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:
Serialized Form

• • Constructor Summary

  Constructors

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

  • Method Summary

  All Methods Instance Methods Concrete Methods

  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 inherited from class java.lang.[Throwable](../../../java/lang/Throwable.html "class in java.lang")  
     `[addSuppressed](../../../java/lang/Throwable.html#addSuppressed-java.lang.Throwable-), [fillInStackTrace](../../../java/lang/Throwable.html#fillInStackTrace--), [getCause](../../../java/lang/Throwable.html#getCause--), [getLocalizedMessage](../../../java/lang/Throwable.html#getLocalizedMessage--), [getStackTrace](../../../java/lang/Throwable.html#getStackTrace--), [getSuppressed](../../../java/lang/Throwable.html#getSuppressed--), [initCause](../../../java/lang/Throwable.html#initCause-java.lang.Throwable-), [printStackTrace](../../../java/lang/Throwable.html#printStackTrace--), [printStackTrace](../../../java/lang/Throwable.html#printStackTrace-java.io.PrintStream-), [printStackTrace](../../../java/lang/Throwable.html#printStackTrace-java.io.PrintWriter-), [setStackTrace](../../../java/lang/Throwable.html#setStackTrace-java.lang.StackTraceElement:A-), [toString](../../../java/lang/Throwable.html#toString--)`  
     * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### PatternSyntaxException  
     public PatternSyntaxException([String](../../../java/lang/String.html "class in java.lang") desc,  
                                   [String](../../../java/lang/String.html "class in java.lang") 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

    * #### 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](../../../java/lang/String.html "class in java.lang") getDescription()  
    Retrieves the description of the error.  
    Returns:  
    The description of the error  
    * #### getPattern  
    public [String](../../../java/lang/String.html "class in java.lang") getPattern()  
    Retrieves the erroneous regular-expression pattern.  
    Returns:  
    The erroneous pattern  
    * #### getMessage  
    public [String](../../../java/lang/String.html "class in java.lang") 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](../../../java/lang/Throwable.html#getMessage--)` in class `[Throwable](../../../java/lang/Throwable.html "class in java.lang")`  
    Returns:  
    The full detail message

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.