Method Details

• close

  public void close()

  Closes this scanner.

  If this scanner has not yet been closed then if its underlying readable also implements the Closeable interface then the readable's close method will be invoked. If this scanner is already closed then invoking this method will have no effect.

  Attempting to perform search operations after a scanner has been closed will result in an IllegalStateException.

  Specified by:

  close in interface AutoCloseable

  Specified by:

  close in interface Closeable

• ioException

  Returns the IOException last thrown by this Scanner's underlying Readable. This method returns null if no such exception exists.

  Returns:

  the last exception thrown by this scanner's readable

• delimiter

  Returns the Pattern this Scanner is currently using to match delimiters.

  Returns:

  this scanner's delimiting pattern.

• useDelimiter

  Sets this scanner's delimiting pattern to the specified pattern.

  Parameters:

  pattern - A delimiting pattern

  Returns:

  this scanner

• useDelimiter

  Sets this scanner's delimiting pattern to a pattern constructed from the specified String.

  An invocation of this method of the form useDelimiter(pattern) behaves in exactly the same way as the invocation useDelimiter(Pattern.compile(pattern)).

  Invoking the reset() method will set the scanner's delimiter to the default.

  Parameters:

  pattern - A string specifying a delimiting pattern

  Returns:

  this scanner

• locale

  Returns this scanner's locale.

  A scanner's locale affects many elements of its default primitive matching regular expressions; see localized numbers above.

  Returns:

  this scanner's locale

• useLocale

  Sets this scanner's locale to the specified locale.

  A scanner's locale affects many elements of its default primitive matching regular expressions; see localized numbers above.

  Invoking the reset() method will set the scanner's locale to the initial locale.

  Parameters:

  locale - A string specifying the locale to use

  Returns:

  this scanner

• radix

  public int radix()

  Returns this scanner's default radix.

  A scanner's radix affects elements of its default number matching regular expressions; see localized numbers above.

  Returns:

  the default radix of this scanner

• useRadix

  public Scanner useRadix(int radix)

  Sets this scanner's default radix to the specified radix.

  A scanner's radix affects elements of its default number matching regular expressions; see localized numbers above.

  If the radix is less than Character.MIN_RADIX or greater than Character.MAX_RADIX, then an IllegalArgumentException is thrown.

  Invoking the reset() method will set the scanner's radix to 10.

  Parameters:

  radix - The radix to use when scanning numbers

  Returns:

  this scanner

  Throws:

  IllegalArgumentException - if radix is out of range

• match

  Returns the match result of the last scanning operation performed by this scanner. This method throws IllegalStateException if no match has been performed, or if the last match was not successful.

  The various next methods of Scanner make a match result available if they complete without throwing an exception. For instance, after an invocation of the nextInt() method that returned an int, this method returns a MatchResult for the search of the Integer regular expression defined above. Similarly the findInLine(), findWithinHorizon(), and skip() methods will make a match available if they succeed.

  Returns:

  a match result for the last match operation

  Throws:

  IllegalStateException - If no match result is available

• toString

  Returns the string representation of this Scanner. The string representation of a Scanner contains information that may be useful for debugging. The exact format is unspecified.

  Overrides:

  toString in class Object

  Returns:

  The string representation of this scanner

• hasNext

  public boolean hasNext()

  Returns true if this scanner has another token in its input. This method may block while waiting for input to scan. The scanner does not advance past any input.

  Specified by:

  hasNext in interface Iterator<String>

  Returns:

  true if and only if this scanner has another token

  Throws:

  IllegalStateException - if this scanner is closed

  See Also:

  • Iterator

• next

  Finds and returns the next complete token from this scanner. A complete token is preceded and followed by input that matches the delimiter pattern. This method may block while waiting for input to scan, even if a previous invocation of hasNext() returned true.

  Specified by:

  next in interface Iterator<String>

  Returns:

  the next token

  Throws:

  NoSuchElementException - if no more tokens are available

  IllegalStateException - if this scanner is closed

  See Also:

  • Iterator

• remove

  public void remove()

  The remove operation is not supported by this implementation of Iterator.

  Specified by:

  remove in interface Iterator<String>

  Throws:

  UnsupportedOperationException - if this method is invoked.

  See Also:

  • Iterator

• hasNext

  public boolean hasNext(String pattern)

  Returns true if the next token matches the pattern constructed from the specified string. The scanner does not advance past any input.

  An invocation of this method of the form hasNext(pattern) behaves in exactly the same way as the invocation hasNext(Pattern.compile(pattern)).

  Parameters:

  pattern - a string specifying the pattern to scan

  Returns:

  true if and only if this scanner has another token matching the specified pattern

  Throws:

  IllegalStateException - if this scanner is closed

• next

  Returns the next token if it matches the pattern constructed from the specified string. If the match is successful, the scanner advances past the input that matched the pattern.

  An invocation of this method of the form next(pattern) behaves in exactly the same way as the invocation next(Pattern.compile(pattern)).

  Parameters:

  pattern - a string specifying the pattern to scan

  Returns:

  the next token

  Throws:

  NoSuchElementException - if no such tokens are available

  IllegalStateException - if this scanner is closed

• hasNext

  public boolean hasNext(Pattern pattern)

  Returns true if the next complete token matches the specified pattern. A complete token is prefixed and postfixed by input that matches the delimiter pattern. This method may block while waiting for input. The scanner does not advance past any input.

  Parameters:

  pattern - the pattern to scan for

  Returns:

  true if and only if this scanner has another token matching the specified pattern

  Throws:

  IllegalStateException - if this scanner is closed

• next

  Returns the next token if it matches the specified pattern. This method may block while waiting for input to scan, even if a previous invocation of hasNext(Pattern) returned true. If the match is successful, the scanner advances past the input that matched the pattern.

  Parameters:

  pattern - the pattern to scan for

  Returns:

  the next token

  Throws:

  NoSuchElementException - if no more tokens are available

  IllegalStateException - if this scanner is closed

• hasNextLine

  public boolean hasNextLine()

  Returns true if there is another line in the input of this scanner. This method may block while waiting for input. The scanner does not advance past any input.

  Returns:

  true if and only if this scanner has another line of input

  Throws:

  IllegalStateException - if this scanner is closed

• nextLine

  Advances this scanner past the current line and returns the input that was skipped. This method returns the rest of the current line, excluding any line separator at the end. The position is set to the beginning of the next line.

  Since this method continues to search through the input looking for a line separator, it may buffer all of the input searching for the line to skip if no line separators are present.

  Returns:

  the line that was skipped

  Throws:

  NoSuchElementException - if no line was found

  IllegalStateException - if this scanner is closed

• findInLine

  Attempts to find the next occurrence of a pattern constructed from the specified string, ignoring delimiters.

  An invocation of this method of the form findInLine(pattern) behaves in exactly the same way as the invocation findInLine(Pattern.compile(pattern)).

  Parameters:

  pattern - a string specifying the pattern to search for

  Returns:

  the text that matched the specified pattern

  Throws:

  IllegalStateException - if this scanner is closed

• findInLine

  Attempts to find the next occurrence of the specified pattern ignoring delimiters. If the pattern is found before the next line separator, the scanner advances past the input that matched and returns the string that matched the pattern. If no such pattern is detected in the input up to the next line separator, then null is returned and the scanner's position is unchanged. This method may block waiting for input that matches the pattern.

  Since this method continues to search through the input looking for the specified pattern, it may buffer all of the input searching for the desired token if no line separators are present.

  Parameters:

  pattern - the pattern to scan for

  Returns:

  the text that matched the specified pattern

  Throws:

  IllegalStateException - if this scanner is closed

• findWithinHorizon

  public String findWithinHorizon(String pattern, int horizon)

  Attempts to find the next occurrence of a pattern constructed from the specified string, ignoring delimiters.

  An invocation of this method of the form findWithinHorizon(pattern) behaves in exactly the same way as the invocation findWithinHorizon(Pattern.compile(pattern), horizon).

  Parameters:

  pattern - a string specifying the pattern to search for

  horizon - the search horizon

  Returns:

  the text that matched the specified pattern

  Throws:

  IllegalStateException - if this scanner is closed

  IllegalArgumentException - if horizon is negative

• findWithinHorizon

  public String findWithinHorizon(Pattern pattern, int horizon)

  Attempts to find the next occurrence of the specified pattern.

  This method searches through the input up to the specified search horizon, ignoring delimiters. If the pattern is found the scanner advances past the input that matched and returns the string that matched the pattern. If no such pattern is detected then the null is returned and the scanner's position remains unchanged. This method may block waiting for input that matches the pattern.

  A scanner will never search more than horizon code points beyond its current position. Note that a match may be clipped by the horizon; that is, an arbitrary match result may have been different if the horizon had been larger. The scanner treats the horizon as a transparent, non-anchoring bound (see Matcher.useTransparentBounds(boolean) and Matcher.useAnchoringBounds(boolean)).

  If horizon is 0, then the horizon is ignored and this method continues to search through the input looking for the specified pattern without bound. In this case it may buffer all of the input searching for the pattern.

  If horizon is negative, then an IllegalArgumentException is thrown.

  Parameters:

  pattern - the pattern to scan for

  horizon - the search horizon

  Returns:

  the text that matched the specified pattern

  Throws:

  IllegalStateException - if this scanner is closed

  IllegalArgumentException - if horizon is negative

• skip

  Skips input that matches the specified pattern, ignoring delimiters. This method will skip input if an anchored match of the specified pattern succeeds.

  If a match to the specified pattern is not found at the current position, then no input is skipped and a NoSuchElementException is thrown.

  Since this method seeks to match the specified pattern starting at the scanner's current position, patterns that can match a lot of input (".*", for example) may cause the scanner to buffer a large amount of input.

  Note that it is possible to skip something without risking a NoSuchElementException by using a pattern that can match nothing, e.g., sc.skip("[ \t]*").

  Parameters:

  pattern - a string specifying the pattern to skip over

  Returns:

  this scanner

  Throws:

  NoSuchElementException - if the specified pattern is not found

  IllegalStateException - if this scanner is closed

• skip

  Skips input that matches a pattern constructed from the specified string.

  An invocation of this method of the form skip(pattern) behaves in exactly the same way as the invocation skip(Pattern.compile(pattern)).

  Parameters:

  pattern - a string specifying the pattern to skip over

  Returns:

  this scanner

  Throws:

  IllegalStateException - if this scanner is closed

• hasNextBoolean

  public boolean hasNextBoolean()

  Returns true if the next token in this scanner's input can be interpreted as a boolean value using a case insensitive pattern created from the string "true|false". The scanner does not advance past the input that matched.

  Returns:

  true if and only if this scanner's next token is a valid boolean value

  Throws:

  IllegalStateException - if this scanner is closed

• nextBoolean

  public boolean nextBoolean()

  Scans the next token of the input into a boolean value and returns that value. This method will throw InputMismatchException if the next token cannot be translated into a valid boolean value. If the match is successful, the scanner advances past the input that matched.

  Returns:

  the boolean scanned from the input

  Throws:

  InputMismatchException - if the next token is not a valid boolean

  NoSuchElementException - if input is exhausted

  IllegalStateException - if this scanner is closed

• hasNextByte

  public boolean hasNextByte()

  Returns true if the next token in this scanner's input can be interpreted as a byte value in the default radix using the nextByte() method. The scanner does not advance past any input.

  Returns:

  true if and only if this scanner's next token is a valid byte value

  Throws:

  IllegalStateException - if this scanner is closed

• hasNextByte

  public boolean hasNextByte(int radix)

  Returns true if the next token in this scanner's input can be interpreted as a byte value in the specified radix using the nextByte() method. The scanner does not advance past any input.

  If the radix is less than Character.MIN_RADIX or greater than Character.MAX_RADIX, then an IllegalArgumentException is thrown.

  Parameters:

  radix - the radix used to interpret the token as a byte value

  Returns:

  true if and only if this scanner's next token is a valid byte value

  Throws:

  IllegalStateException - if this scanner is closed

  IllegalArgumentException - if the radix is out of range

• nextByte

  public byte nextByte()

  Scans the next token of the input as a byte.

  An invocation of this method of the form nextByte() behaves in exactly the same way as the invocation nextByte(radix), where radix is the default radix of this scanner.

  Returns:

  the byte scanned from the input

  Throws:

  InputMismatchException - if the next token does not match the Integer regular expression, or is out of range

  NoSuchElementException - if input is exhausted

  IllegalStateException - if this scanner is closed

• nextByte

  public byte nextByte(int radix)

  Scans the next token of the input as a byte. This method will throw InputMismatchException if the next token cannot be translated into a valid byte value as described below. If the translation is successful, the scanner advances past the input that matched.

  If the next token matches the Integer regular expression defined above then the token is converted into a byte value as if by removing all locale specific prefixes, group separators, and locale specific suffixes, then mapping non-ASCII digits into ASCII digits via Character.digit, prepending a negative sign (-) if the locale specific negative prefixes and suffixes were present, and passing the resulting string to Byte.parseByte with the specified radix.

  If the radix is less than Character.MIN_RADIX or greater than Character.MAX_RADIX, then an IllegalArgumentException is thrown.

  Parameters:

  radix - the radix used to interpret the token as a byte value

  Returns:

  the byte scanned from the input

  Throws:

  InputMismatchException - if the next token does not match the Integer regular expression, or is out of range

  NoSuchElementException - if input is exhausted

  IllegalStateException - if this scanner is closed

  IllegalArgumentException - if the radix is out of range

• hasNextShort

  public boolean hasNextShort()

  Returns true if the next token in this scanner's input can be interpreted as a short value in the default radix using the nextShort() method. The scanner does not advance past any input.

  Returns:

  true if and only if this scanner's next token is a valid short value in the default radix

  Throws:

  IllegalStateException - if this scanner is closed

• hasNextShort

  public boolean hasNextShort(int radix)

  Returns true if the next token in this scanner's input can be interpreted as a short value in the specified radix using the nextShort() method. The scanner does not advance past any input.

  If the radix is less than Character.MIN_RADIX or greater than Character.MAX_RADIX, then an IllegalArgumentException is thrown.

  Parameters:

  radix - the radix used to interpret the token as a short value

  Returns:

  true if and only if this scanner's next token is a valid short value in the specified radix

  Throws:

  IllegalStateException - if this scanner is closed

  IllegalArgumentException - if the radix is out of range

• nextShort

  public short nextShort()

  Scans the next token of the input as a short.

  An invocation of this method of the form nextShort() behaves in exactly the same way as the invocation nextShort(radix), where radix is the default radix of this scanner.

  Returns:

  the short scanned from the input

  Throws:

  InputMismatchException - if the next token does not match the Integer regular expression, or is out of range

  NoSuchElementException - if input is exhausted

  IllegalStateException - if this scanner is closed

• nextShort

  public short nextShort(int radix)

  Scans the next token of the input as a short. This method will throw InputMismatchException if the next token cannot be translated into a valid short value as described below. If the translation is successful, the scanner advances past the input that matched.

  If the next token matches the Integer regular expression defined above then the token is converted into a short value as if by removing all locale specific prefixes, group separators, and locale specific suffixes, then mapping non-ASCII digits into ASCII digits via Character.digit, prepending a negative sign (-) if the locale specific negative prefixes and suffixes were present, and passing the resulting string to Short.parseShort with the specified radix.

  If the radix is less than Character.MIN_RADIX or greater than Character.MAX_RADIX, then an IllegalArgumentException is thrown.

  Parameters:

  radix - the radix used to interpret the token as a short value

  Returns:

  the short scanned from the input

  Throws:

  InputMismatchException - if the next token does not match the Integer regular expression, or is out of range

  NoSuchElementException - if input is exhausted

  IllegalStateException - if this scanner is closed

  IllegalArgumentException - if the radix is out of range

• hasNextInt

  public boolean hasNextInt()

  Returns true if the next token in this scanner's input can be interpreted as an int value in the default radix using the nextInt() method. The scanner does not advance past any input.

  Returns:

  true if and only if this scanner's next token is a valid int value

  Throws:

  IllegalStateException - if this scanner is closed

• hasNextInt

  public boolean hasNextInt(int radix)

  Returns true if the next token in this scanner's input can be interpreted as an int value in the specified radix using the nextInt() method. The scanner does not advance past any input.

  If the radix is less than Character.MIN_RADIX or greater than Character.MAX_RADIX, then an IllegalArgumentException is thrown.

  Parameters:

  radix - the radix used to interpret the token as an int value

  Returns:

  true if and only if this scanner's next token is a valid int value

  Throws:

  IllegalStateException - if this scanner is closed

  IllegalArgumentException - if the radix is out of range

• nextInt

  public int nextInt()

  Scans the next token of the input as an int.

  An invocation of this method of the form nextInt() behaves in exactly the same way as the invocation nextInt(radix), where radix is the default radix of this scanner.

  Returns:

  the int scanned from the input

  Throws:

  InputMismatchException - if the next token does not match the Integer regular expression, or is out of range

  NoSuchElementException - if input is exhausted

  IllegalStateException - if this scanner is closed

• nextInt

  public int nextInt(int radix)

  Scans the next token of the input as an int. This method will throw InputMismatchException if the next token cannot be translated into a valid int value as described below. If the translation is successful, the scanner advances past the input that matched.

  If the next token matches the Integer regular expression defined above then the token is converted into an int value as if by removing all locale specific prefixes, group separators, and locale specific suffixes, then mapping non-ASCII digits into ASCII digits via Character.digit, prepending a negative sign (-) if the locale specific negative prefixes and suffixes were present, and passing the resulting string to Integer.parseInt with the specified radix.

  If the radix is less than Character.MIN_RADIX or greater than Character.MAX_RADIX, then an IllegalArgumentException is thrown.

  Parameters:

  radix - the radix used to interpret the token as an int value

  Returns:

  the int scanned from the input

  Throws:

  InputMismatchException - if the next token does not match the Integer regular expression, or is out of range

  NoSuchElementException - if input is exhausted

  IllegalStateException - if this scanner is closed

  IllegalArgumentException - if the radix is out of range

• hasNextLong

  public boolean hasNextLong()

  Returns true if the next token in this scanner's input can be interpreted as a long value in the default radix using the nextLong() method. The scanner does not advance past any input.

  Returns:

  true if and only if this scanner's next token is a valid long value

  Throws:

  IllegalStateException - if this scanner is closed

• hasNextLong

  public boolean hasNextLong(int radix)

  Returns true if the next token in this scanner's input can be interpreted as a long value in the specified radix using the nextLong() method. The scanner does not advance past any input.

  If the radix is less than Character.MIN_RADIX or greater than Character.MAX_RADIX, then an IllegalArgumentException is thrown.

  Parameters:

  radix - the radix used to interpret the token as a long value

  Returns:

  true if and only if this scanner's next token is a valid long value

  Throws:

  IllegalStateException - if this scanner is closed

  IllegalArgumentException - if the radix is out of range

• nextLong

  public long nextLong()

  Scans the next token of the input as a long.

  An invocation of this method of the form nextLong() behaves in exactly the same way as the invocation nextLong(radix), where radix is the default radix of this scanner.

  Returns:

  the long scanned from the input

  Throws:

  InputMismatchException - if the next token does not match the Integer regular expression, or is out of range

  NoSuchElementException - if input is exhausted

  IllegalStateException - if this scanner is closed

• nextLong

  public long nextLong(int radix)

  Scans the next token of the input as a long. This method will throw InputMismatchException if the next token cannot be translated into a valid long value as described below. If the translation is successful, the scanner advances past the input that matched.

  If the next token matches the Integer regular expression defined above then the token is converted into a long value as if by removing all locale specific prefixes, group separators, and locale specific suffixes, then mapping non-ASCII digits into ASCII digits via Character.digit, prepending a negative sign (-) if the locale specific negative prefixes and suffixes were present, and passing the resulting string to Long.parseLong with the specified radix.

  If the radix is less than Character.MIN_RADIX or greater than Character.MAX_RADIX, then an IllegalArgumentException is thrown.

  Parameters:

  radix - the radix used to interpret the token as an int value

  Returns:

  the long scanned from the input

  Throws:

  InputMismatchException - if the next token does not match the Integer regular expression, or is out of range

  NoSuchElementException - if input is exhausted

  IllegalStateException - if this scanner is closed

  IllegalArgumentException - if the radix is out of range

• hasNextFloat

  public boolean hasNextFloat()

  Returns true if the next token in this scanner's input can be interpreted as a float value using the nextFloat() method. The scanner does not advance past any input.

  Returns:

  true if and only if this scanner's next token is a valid float value

  Throws:

  IllegalStateException - if this scanner is closed

• nextFloat

  public float nextFloat()

  Scans the next token of the input as a float. This method will throw InputMismatchException if the next token cannot be translated into a valid float value as described below. If the translation is successful, the scanner advances past the input that matched.

  If the next token matches the Float regular expression defined above then the token is converted into a float value as if by removing all locale specific prefixes, group separators, and locale specific suffixes, then mapping non-ASCII digits into ASCII digits via Character.digit, prepending a negative sign (-) if the locale specific negative prefixes and suffixes were present, and passing the resulting string to Float.parseFloat. If the token matches the localized NaN or infinity strings, then either "Nan" or "Infinity" is passed to Float.parseFloat as appropriate.

  Returns:

  the float scanned from the input

  Throws:

  InputMismatchException - if the next token does not match the Float regular expression, or is out of range

  NoSuchElementException - if input is exhausted

  IllegalStateException - if this scanner is closed

• hasNextDouble

  public boolean hasNextDouble()

  Returns true if the next token in this scanner's input can be interpreted as a double value using the nextDouble() method. The scanner does not advance past any input.

  Returns:

  true if and only if this scanner's next token is a valid double value

  Throws:

  IllegalStateException - if this scanner is closed

• nextDouble

  public double nextDouble()

  Scans the next token of the input as a double. This method will throw InputMismatchException if the next token cannot be translated into a valid double value. If the translation is successful, the scanner advances past the input that matched.

  If the next token matches the Float regular expression defined above then the token is converted into a double value as if by removing all locale specific prefixes, group separators, and locale specific suffixes, then mapping non-ASCII digits into ASCII digits via Character.digit, prepending a negative sign (-) if the locale specific negative prefixes and suffixes were present, and passing the resulting string to Double.parseDouble. If the token matches the localized NaN or infinity strings, then either "Nan" or "Infinity" is passed to Double.parseDouble as appropriate.

  Returns:

  the double scanned from the input

  Throws:

  InputMismatchException - if the next token does not match the Float regular expression, or is out of range

  NoSuchElementException - if the input is exhausted

  IllegalStateException - if this scanner is closed

• hasNextBigInteger

  public boolean hasNextBigInteger()

  Returns true if the next token in this scanner's input can be interpreted as a BigInteger in the default radix using the nextBigInteger() method. The scanner does not advance past any input.

  Returns:

  true if and only if this scanner's next token is a valid BigInteger

  Throws:

  IllegalStateException - if this scanner is closed

• hasNextBigInteger

  public boolean hasNextBigInteger(int radix)

  Returns true if the next token in this scanner's input can be interpreted as a BigInteger in the specified radix using the nextBigInteger() method. The scanner does not advance past any input.

  If the radix is less than Character.MIN_RADIX or greater than Character.MAX_RADIX, then an IllegalArgumentException is thrown.

  Parameters:

  radix - the radix used to interpret the token as an integer

  Returns:

  true if and only if this scanner's next token is a valid BigInteger

  Throws:

  IllegalStateException - if this scanner is closed

  IllegalArgumentException - if the radix is out of range

• nextBigInteger

  Scans the next token of the input as a BigInteger.

  An invocation of this method of the form nextBigInteger() behaves in exactly the same way as the invocation nextBigInteger(radix), where radix is the default radix of this scanner.

  Returns:

  the BigInteger scanned from the input

  Throws:

  InputMismatchException - if the next token does not match the Integer regular expression, or is out of range

  NoSuchElementException - if the input is exhausted

  IllegalStateException - if this scanner is closed

• nextBigInteger

  public BigInteger nextBigInteger(int radix)

  Scans the next token of the input as a BigInteger.

  If the next token matches the Integer regular expression defined above then the token is converted into a BigInteger value as if by removing all group separators, mapping non-ASCII digits into ASCII digits via the Character.digit, and passing the resulting string to the BigInteger(String, int) constructor with the specified radix.

  If the radix is less than Character.MIN_RADIX or greater than Character.MAX_RADIX, then an IllegalArgumentException is thrown.

  Parameters:

  radix - the radix used to interpret the token

  Returns:

  the BigInteger scanned from the input

  Throws:

  InputMismatchException - if the next token does not match the Integer regular expression, or is out of range

  NoSuchElementException - if the input is exhausted

  IllegalStateException - if this scanner is closed

  IllegalArgumentException - if the radix is out of range

• hasNextBigDecimal

  public boolean hasNextBigDecimal()

  Returns true if the next token in this scanner's input can be interpreted as a BigDecimal using the nextBigDecimal() method. The scanner does not advance past any input.

  Returns:

  true if and only if this scanner's next token is a valid BigDecimal

  Throws:

  IllegalStateException - if this scanner is closed

• nextBigDecimal

  Scans the next token of the input as a BigDecimal.

  If the next token matches the Decimal regular expression defined above then the token is converted into a BigDecimal value as if by removing all group separators, mapping non-ASCII digits into ASCII digits via the Character.digit, and passing the resulting string to the BigDecimal(String) constructor.

  Returns:

  the BigDecimal scanned from the input

  Throws:

  InputMismatchException - if the next token does not match the Decimal regular expression, or is out of range

  NoSuchElementException - if the input is exhausted

  IllegalStateException - if this scanner is closed

• reset

  Resets this scanner.

  Resetting a scanner discards all of its explicit state information which may have been changed by invocations of useDelimiter(), useLocale(), or useRadix().

  An invocation of this method of the form scanner.reset() behaves in exactly the same way as the invocation

  
     scanner.useDelimiter("\\p{javaWhitespace}+")
            .useLocale(Locale.getDefault(Locale.Category.FORMAT))
            .useRadix(10);
   

  Returns:

  this scanner

  Since:

  1.6

• tokens

  Returns a stream of delimiter-separated tokens from this scanner. The stream contains the same tokens that would be returned, starting from this scanner's current state, by calling the next() method repeatedly until the hasNext() method returns false.

  The resulting stream is sequential and ordered. All stream elements are non-null.

  Scanning starts upon initiation of the terminal stream operation, using the current state of this scanner. Subsequent calls to any methods on this scanner other than close() and ioException() may return undefined results or may cause undefined effects on the returned stream. The returned stream's source Spliterator is fail-fast and will, on a best-effort basis, throw a ConcurrentModificationException if any such calls are detected during stream pipeline execution.

  After stream pipeline execution completes, this scanner is left in an indeterminate state and cannot be reused.

  If this scanner contains a resource that must be released, this scanner should be closed, either by calling its close() method, or by closing the returned stream. Closing the stream will close the underlying scanner. IllegalStateException is thrown if the scanner has been closed when this method is called, or if this scanner is closed during stream pipeline execution.

  This method might block waiting for more input.

  API Note:

  For example, the following code will create a list of comma-delimited tokens from a string:

  
   List<String> result = new Scanner("abc,def,,ghi")
       .useDelimiter(",")
       .tokens()
       .collect(Collectors.toList());
   

  The resulting list would contain "abc", "def", the empty string, and "ghi".

  Returns:

  a sequential stream of token strings

  Throws:

  IllegalStateException - if this scanner is closed

  Since:

  9

• findAll

  Returns a stream of match results from this scanner. The stream contains the same results in the same order that would be returned by calling findWithinHorizon(pattern, 0) and then match() successively as long as findWithinHorizon() finds matches.

  The resulting stream is sequential and ordered. All stream elements are non-null.

  Scanning starts upon initiation of the terminal stream operation, using the current state of this scanner. Subsequent calls to any methods on this scanner other than close() and ioException() may return undefined results or may cause undefined effects on the returned stream. The returned stream's source Spliterator is fail-fast and will, on a best-effort basis, throw a ConcurrentModificationException if any such calls are detected during stream pipeline execution.

  After stream pipeline execution completes, this scanner is left in an indeterminate state and cannot be reused.

  If this scanner contains a resource that must be released, this scanner should be closed, either by calling its close() method, or by closing the returned stream. Closing the stream will close the underlying scanner. IllegalStateException is thrown if the scanner has been closed when this method is called, or if this scanner is closed during stream pipeline execution.

  As with the findWithinHorizon() methods, this method might block waiting for additional input, and it might buffer an unbounded amount of input searching for a match.

  API Note:

  For example, the following code will read a file and return a list of all sequences of characters consisting of seven or more Latin capital letters:

  
   try (Scanner sc = new Scanner(Path.of("input.txt"))) {
       Pattern pat = Pattern.compile("[A-Z]{7,}");
       List<String> capWords = sc.findAll(pat)
                                 .map(MatchResult::group)
                                 .collect(Collectors.toList());
   }
   

  Parameters:

  pattern - the pattern to be matched

  Returns:

  a sequential stream of match results

  Throws:

  NullPointerException - if pattern is null

  IllegalStateException - if this scanner is closed

  Since:

  9

• findAll

  Returns a stream of match results that match the provided pattern string. The effect is equivalent to the following code:

  
       scanner.findAll(Pattern.compile(patString))
   

  Parameters:

  patString - the pattern string

  Returns:

  a sequential stream of match results

  Throws:

  NullPointerException - if patString is null

  IllegalStateException - if this scanner is closed

  PatternSyntaxException - if the regular expression's syntax is invalid

  Since:

  9

  See Also:

  • Pattern