Package org.checkerframework.checker.regex.util

Class RegexUtil

java.lang.Object

org.checkerframework.checker.regex.util.RegexUtil

@AnnotatedFor("nullness")
public final class RegexUtil
extends Object

Utility methods for regular expressions, most notably for testing whether a string is a regular expression.

For an example of intended use, see section Testing whether a string is a regular expression in the Checker Framework manual.

Runtime Dependency: If you use this class, you must distribute (or link to) checker-qual.jar, along with your binaries. Or, you can copy this class into your own project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RegexUtil.CheckedPatternSyntaxException	A checked version of PatternSyntaxException.

Method Summary

Modifier and Type	Method	Description
static @Regex String	asRegex(String s)	Returns the argument as a @Regex String if it is a regex, otherwise throws an error.
static @Regex String	asRegex(String s, int groups)	Returns the argument as a @Regex(groups) String if it is a regex with at least the given number of groups, otherwise throws an error.
static boolean	isRegex(char c)	Returns true if the argument is a syntactically valid regular expression.
static boolean	isRegex(String s)	Returns true if the argument is a syntactically valid regular expression.
static boolean	isRegex(String s, int groups)	Returns true if the argument is a syntactically valid regular expression with at least the given number of groups.
static @Nullable String	regexError(String s)	Returns null if the argument is a syntactically valid regular expression.
static @Nullable String	regexError(String s, int groups)	Returns null if the argument is a syntactically valid regular expression with at least the given number of groups.
static @Nullable PatternSyntaxException	regexException(String s)	Returns null if the argument is a syntactically valid regular expression.
static @Nullable PatternSyntaxException	regexException(String s, int groups)	Returns null if the argument is a syntactically valid regular expression with at least the given number of groups.

Methods inherited from class java.lang.Object

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

Method Details

isRegex

@Pure
@EnsuresQualifierIf(result=true,
                    expression="#1",
                    qualifier=Regex.class)
public static boolean isRegex(String s)

Returns true if the argument is a syntactically valid regular expression.

Parameters:

s - string to check for being a regular expression

Returns:

true iff s is a regular expression

isRegex

@Pure
@EnsuresQualifierIf(result=true,
                    expression="#1",
                    qualifier=Regex.class)
public static boolean isRegex(String s,
 int groups)

Returns true if the argument is a syntactically valid regular expression with at least the given number of groups.

Parameters:

s - string to check for being a regular expression

groups - number of groups expected

Returns:

true iff s is a regular expression with groups groups

isRegex

@Pure
@EnsuresQualifierIf(result=true,
                    expression="#1",
                    qualifier=Regex.class)
public static boolean isRegex(char c)

Returns true if the argument is a syntactically valid regular expression.

Parameters:

c - char to check for being a regular expression

Returns:

true iff c is a regular expression

regexError

@SideEffectFree
public static @Nullable String regexError(String s)

Returns null if the argument is a syntactically valid regular expression. Otherwise returns a string describing why the argument is not a regex.

Parameters:

s - string to check for being a regular expression

Returns:

null, or a string describing why the argument is not a regex

regexError

@SideEffectFree
public static @Nullable String regexError(String s,
 int groups)

Returns null if the argument is a syntactically valid regular expression with at least the given number of groups. Otherwise returns a string describing why the argument is not a regex.

Parameters:

s - string to check for being a regular expression

groups - number of groups expected

Returns:

null, or a string describing why the argument is not a regex

regexException

@SideEffectFree
public static @Nullable PatternSyntaxException regexException(String s)

Returns null if the argument is a syntactically valid regular expression. Otherwise returns a PatternSyntaxException describing why the argument is not a regex.

Parameters:

s - string to check for being a regular expression

Returns:

null, or a PatternSyntaxException describing why the argument is not a regex

regexException

@SideEffectFree
public static @Nullable PatternSyntaxException regexException(String s,
 int groups)

Returns null if the argument is a syntactically valid regular expression with at least the given number of groups. Otherwise returns a PatternSyntaxException describing why the argument is not a regex.

Parameters:

s - string to check for being a regular expression

groups - number of groups expected

Returns:

null, or a PatternSyntaxException describing why the argument is not a regex

asRegex

@SideEffectFree
public static @Regex String asRegex(String s)

Returns the argument as a @Regex String if it is a regex, otherwise throws an error.

The purpose of this method is to suppress Regex Checker warnings. It should be very rarely needed.

Parameters:

s - string to check for being a regular expression

Returns:

its argument

Throws:

Error - if argument is not a regex

asRegex

@SideEffectFree
public static @Regex String asRegex(String s,
 int groups)

Returns the argument as a @Regex(groups) String if it is a regex with at least the given number of groups, otherwise throws an error.

The purpose of this method is to suppress Regex Checker warnings. It should be very rarely needed.

Parameters:

s - string to check for being a regular expression

groups - number of groups expected

Returns:

its argument

Throws:

Error - if argument is not a regex