View Javadoc

1   /*
2    * EL4J, the Extension Library for the J2EE, adds incremental enhancements to
3    * the spring framework, http://el4j.sf.net
4    * Copyright (C) 2009 by ELCA Informatique SA, Av. de la Harpe 22-24,
5    * 1000 Lausanne, Switzerland, http://www.elca.ch
6    *
7    * EL4J is published under the GNU Lesser General Public License (LGPL)
8    * Version 2.1. See http://www.gnu.org/licenses/
9    *
10   * This program is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13   * GNU Lesser General Public License for more details.
14   *
15   * For alternative licensing, please contact info@elca.ch
16   */
17  package ch.elca.el4j.util.codingsupport.annotations;
18  
19  import java.lang.annotation.Annotation;
20  
21  /**
22   * 
23   * This is a substitute for the annotation SuppressWarnings that FindBugs normally would use.
24   * As SuppressWarnings is already used in java.lang package, using this annotation avoids a name clash.
25   * FindBugs only cares for the last part of the annotation name, which has to be SuppressWarnings. 
26   *
27   * @svnLink $Revision: 4083 $;$Date: 2010-01-08 13:32:17 +0100 (Fr, 08. Jan 2010) $;$Author: jonasha $;$URL: https://el4j.svn.sourceforge.net/svnroot/el4j/branches/el4j_3_1/el4j/framework/modules/core/src/main/java/ch/elca/el4j/util/codingsupport/annotations/FindBugsSuppressWarnings.java $
28   *
29   * @author Daniel Thomas (DTH)
30   */
31  
32  public @interface FindBugsSuppressWarnings {
33  
34  	/**
35  	 * Is the name of the bug that we want to suppress.
36  	 * 
37  	 * @return
38  	 */
39  	public abstract String[] value();
40  
41  	/**
42  	 * Is the justification for suppressing this bug.
43  	 * 
44  	 * @return
45  	 */
46  	
47  	public abstract String justification();
48  
49  }