de.larssh.utils.text

Class Patterns

java.lang.Object

de.larssh.utils.text.Patterns

public final class Patterns
extends Object

This class contains helper methods for Pattern.

Method Summary

Modifier and Type	Method and Description
static Optional<Matcher>	find(Pattern pattern, CharSequence input) Attempts to find the first subsequence of the input sequence that matches the given pattern.
static Optional<Matcher>	matches(Pattern pattern, CharSequence input) Attempts to match the entire region against the pattern.
static String	quote(CharSequence input) Returns a pattern string matching exactly input.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

find

public static Optional<Matcher> find(Pattern pattern,
                                     CharSequence input)

Attempts to find the first subsequence of the input sequence that matches the given pattern.

Use Strings.find(CharSequence, Pattern) if you do not need a matcher.

Parameters:

pattern - the pattern

input - the input sequence to find the pattern in

Returns:

if the match succeeds then more information can be obtained via the returned Matcher object or else Optional.empty() is returned

matches

public static Optional<Matcher> matches(Pattern pattern,
                                        CharSequence input)

Attempts to match the entire region against the pattern.

Use Strings.matches(CharSequence, Pattern) if you do not need a matcher.

Parameters:

pattern - the pattern

input - the input sequence to match against the pattern

Returns:

if the match succeeds then more information can be obtained via the returned Matcher object or else Optional.empty() is returned

quote

public static String quote(CharSequence input)

Returns a pattern string matching exactly input.

This method escapes character-wise, while the original Pattern.quote(String) uses escapes sequences using \Q and \E.

Example: C:\test.txt results in C:\\test\.txt.

Parameters:

input - the string to be literalized

Returns:

the literal string replacement