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

Go to download

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

The Checker Framework enhances Java's type system to make it more powerful and useful. This lets software developers detect and prevent errors in their Java programs. The Checker Framework includes compiler plug-ins ("checkers") that find bugs or verify their absence. It also permits you to write your own compiler plug-ins.

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 none 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 DoesNotMatchRegex {
    /**
     * A set of Java regular expressions.
     *
     * @return the regular expressions
     */
    String[] value();
}