org.checkerframework.checker.regex.qual

Annotation Type Regex

@Retention(value=RUNTIME)
 @Target(value={TYPE_USE,TYPE_PARAMETER})
 @Repeatable(value=MultiRegex.class)
 @SubtypeOf(value=UnknownRegex.class)
public @interface Regex

If a type is annotated as @Regex(n), then the run-time value is a regular expression with n capturing groups.

For example, if an expression's type is @Regex(2) String, then at run time its value will be a legal regular expression with at least two capturing groups. The type states that possible run-time values include "(a*)(b*)", "a(b?)c(d?)e", and "(.)(.)(.)", but not "hello" nor "(good)bye" nor "(a*)(b*)(".

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	param The name of the qualifier parameter to set.
int	value The number of groups in the regular expression.
Wildcard	wildcard Specify that this use is a wildcard with a bound.

Element Detail

value

public abstract int value

The number of groups in the regular expression. Defaults to 0.

Default:

0

param

public abstract String param

The name of the qualifier parameter to set.

Default:

"_primary"

wildcard

public abstract Wildcard wildcard

Specify that this use is a wildcard with a bound.

Default:

org.checkerframework.qualframework.poly.qual.Wildcard.NONE