Rationale for Matcher throwing IllegalStateException when no ‘matching’ method is called

by

Actually, you misunderstood the documentation. Take a 2nd look at the statement you quoted: –

attempting to query any part of it before a successful match will cause an
IllegalStateException to be thrown.

A matcher may throw IllegalStateException on accessing matcher.group() if no match was found.

So, you need to use following test, to actually initiate the matching process: –

 - matcher.matches() //Or
 - matcher.find()

The below code: –

Matcher matcher = pattern.matcher();

Just creates a matcher instance. This will not actually match a string. Even if there was a successful match.
So, you need to check the following condition, to check for successful matches: –

if (matcher.matches()) {
    // Then use `matcher.group()`
}

And if the condition in the if returns false, that means nothing was matched. So, if you use matcher.group() without checking this condition, you will get IllegalStateException if the match was not found.

Suppose, if Matcher was designed the way you are saying, then you would have to do a null check to check whether a match was found or not, to call matcher.group(), like this: –

The way you think should have been done:-

// Suppose this returned the matched string
Matcher matcher = pattern.matcher(s);  

// Need to check whether there was actually a match
if (matcher != null) {  // Prints only the first match

    System.out.println(matcher.group());
}

But, what if, you want to print any further matches, since a pattern can be matched multiple times in a String, for that, there should be a way to tell the matcher to find the next match. But the null check would not be able to do that. For that you would have to move your matcher forward to match the next String. So, there are various methods defined in Matcher class to serve the purpose. The matcher.find() method matches the String till all the matches is found.

There are other methods also, that match the string in a different way, that depends on you how you want to match. So its ultimately on Matcher class to do the matching against the string. Pattern class just creates a pattern to match against. If the Pattern.matcher() were to match the pattern, then there has to be some way to define various ways to match, as matching can be in different ways. So, there comes the need of Matcher class.

So, the way it actually is: –

Matcher matcher = pattern.matcher(s);

   // Finds all the matches until found by moving the `matcher` forward
while(matcher.find()) {
    System.out.println(matcher.group());
}

So, if there are 4 matches found in the string, your first way, would print only the first one, while the 2nd way will print all the matches, by moving the matcher forward to match the next pattern.

I Hope that makes it clear.

The documentation of Matcher class describes the use of the three methods it provides, which says: –

A matcher is created from a pattern by invoking the pattern’s matcher
method. Once created, a matcher can be used to perform three different
kinds of match operations:

  • The matches method attempts to match the entire input sequence
    against the pattern.

  • The lookingAt method attempts to match the input sequence, starting
    at the beginning, against the pattern.

  • The find method scans the input sequence looking for the next
    subsequence that matches the pattern.

Unfortunately, I have not been able find any other official sources, saying explicitly Why and How of this issue.

More Related Contents:

  1. simple java regex throwing illegalstateexception [duplicate]
  2. Looking for Correct Java REGEX for this kind of payload
  3. Reg expression to accept values between 1 and 48? [closed]
  4. Finding smilies with Pattern in java
  5. Difference between matches() and find() in Java Regex
  6. Split Java String by New Line
  7. Using Regex to generate Strings rather than match them
  8. How to count the number of documents under a collection in Firestore?
  9. Whitespace Matching Regex – Java
  10. How can non-ASCII characters be removed from a string?
  11. How to match string within parentheses (nested) in Java?
  12. Regex look-behind without obvious maximum length in Java
  13. Returning overlapping regular expressions
  14. A regex to match a substring that isn’t followed by a certain other substring
  15. Java; String replace (using regular expressions)?
  16. Java regular expressions and dollar sign
  17. Java doesn’t work with regex \s, says: invalid escape sequence
  18. Cancelling a long running regex match?
  19. Regular expression to match a backslash followed by a quote
  20. Why String.replaceAll() in java requires 4 slashes “\\\\” in regex to actually replace “\”?
  21. How to filter string for unwanted characters using regex?
  22. Split a string, at every nth position
  23. How to find the exact word using a regex in Java?
  24. Backreferences in lookbehind
  25. How can I find repeated characters with a regex in Java?
  26. Regular expression to match optional end of string
  27. String.replaceAll is considerably slower than doing the job yourself
  28. Remove all occurrences of \ from string
  29. Extract ip addresses from Strings using regex
  30. Validate if input string is a number between 0-255 using regex

Leave a Comment