checker.src.org.checkerframework.checker.regex.classic.qual.PartialRegex Maven / Gradle / Ivy

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.

There is a newer version: 3.42.0

Show newest version

package org.checkerframework.checker.regex.classic.qual;

import java.lang.annotation.Target;

import org.checkerframework.framework.qual.InvisibleQualifier;
import org.checkerframework.framework.qual.SubtypeOf;

/**
 * Indicates a String that is not a syntactically valid regular expression.
 * The String itself can be stored as a parameter to the annotation,
 * allowing the Regex Checker to verify some concatenations of partial
 * regular expression Strings.
 * 
 *
 * This annotation may not be written in source code; it is an
 * implementation detail of the Regex Checker.
 *
 * @checker_framework.manual #regex-checker Regex Checker
 */
@InvisibleQualifier
@SubtypeOf(UnknownRegex.class)
@Target({}) // empty target prevents programmers from writing this in a program
public @interface PartialRegex {

    /**
     * The String qualified by this annotation. Used to verify concatenation
     * of partial regular expressions. Defaults to the empty String.
     */
    String value() default "";
}