suppresswarnings.java

A static analysis tool to find bugs in Java programs

/*
 * Bytecode Analysis Framework
 * Copyright (C) 2005 University of Maryland
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package edu.umd.cs.findbugs.annotations;

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

@Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD,
		 ElementType.PARAMETER, ElementType.CONSTRUCTOR,
		 ElementType.LOCAL_VARIABLE, ElementType.PACKAGE})
@Retention(RetentionPolicy.CLASS)
public @interface SuppressWarnings {
	/**
	 * The set of warnings that are to be suppressed by the compiler in the
	 * annotated element.  
	 * 
	 * Duplicate names are permitted.  The second and
	 * successive occurrences of a name are ignored.  The presence of
	 * unrecognized warning names is <i>not</i> an error: Compilers must
	 * ignore any warning names they do not recognize.  They are, however,
	 * free to emit a warning if an annotation contains an unrecognized
	 * warning name.
	 *
	 * <p>Compiler vendors should document the warning names they support in
	 * conjunction with this annotation type. They are encouraged to cooperate
	 * to ensure that the same names work across multiple compilers.
	 */
	String[] value() default {};
	String justification() default "";
}