/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */

package edu.umd.cs.findbugs.annotations;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

import edu.umd.cs.findbugs.BugRanker;

Annotation indicating that a FindBugs warning is expected.
See http://code.google.com/p/findbugs/wiki/FindbugsTestCases
Author:
David Hovemeyer/**
 * Annotation indicating that a FindBugs warning is expected.
 *
 * See http://code.google.com/p/findbugs/wiki/FindbugsTestCases
 *
 * @author David Hovemeyer
 */
@Retention(RetentionPolicy.CLASS)
public @interface ExpectWarning {
    
The value indicates the bug code (e.g., NP) or bug pattern (e.g.,
IL_INFINITE_LOOP) of the expected warning. Can be a comma-separated list.
/**
     * The value indicates the bug code (e.g., NP) or bug pattern (e.g.,
     * IL_INFINITE_LOOP) of the expected warning. Can be a comma-separated list.
     */
    public String value();

    
Want a warning at this priority or higher /** Want a warning at this priority or higher */
    public Confidence confidence() default Confidence.LOW;

    
Expect a warning at least this scary /** Expect a warning at least this scary */
    public int rank() default BugRanker.VISIBLE_RANK_MAX;

    
Expect at least this many warnings /** Expect at least this many warnings */
    public int num() default 1;
}