org.checkerframework.common.value.qual.MatchesRegex Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of checker-qual Show documentation

checker-qual contains annotations (type qualifiers) that a programmer writes to specify Java code for type-checking by the Checker Framework.

The newest version!

package org.checkerframework.common.value.qual;

import org.checkerframework.framework.qual.SubtypeOf;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * An annotation indicating the possible values for a String type. The annotation's arguments are
 * Java regular expressions. If an expression's type has this annotation, then at run time, the
 * expression evaluates to a string that matches at least one of the regular expressions. Matching
 * is via the java.lang.String#matches
 * method, which matches against the entire string (it does not look for a match against a
 * substring).
 *
 * @checker_framework.manual #constant-value-checker Constant Value Checker
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE_PARAMETER, ElementType.TYPE_USE})
@SubtypeOf({UnknownVal.class})
public @interface MatchesRegex {
    /**
     * A set of Java regular expressions.
     *
     * @return the regular expressions
     */
    String[] value();
}