OverrideMustInvoke


1   /*
2    * FindBugs - Find Bugs in Java programs
3    * Copyright (C) 2005-2006, University of Maryland
4    * 
5    * This library is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU Lesser General Public
7    * License as published by the Free Software Foundation; either
8    * version 2.1 of the License, or (at your option) any later version.
9    * 
10   * This library 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 GNU
13   * Lesser General Public License for more details.
14   * 
15   * You should have received a copy of the GNU Lesser General Public
16   * License along with this library; if not, write to the Free Software
17   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   */
19  
20  package edu.umd.cs.findbugs.annotations;
21  
22  import java.lang.annotation.Documented  ;
23  import java.lang.annotation.ElementType  ;
24  import java.lang.annotation.Retention  ;
25  import java.lang.annotation.RetentionPolicy  ;
26  import java.lang.annotation.Target  ;
27  
28  /**
29   * Used to annotate a method that, if overridden, must (or should) be invoked
30   * by an invocation on super in the overriding method. Examples
31   * of such methods include finalize() and clone().
32   * 
33   * The argument to the method indicates when the super invocation should
34   * occur: at any time, at the beginning of the overriding method, or at the end
35   * of the overriding method.
36   * @see edu.umd.cs.findbugs.annotations.When
37   **/
38  @Documented  
39  @Target  ({ElementType.METHOD })
40  @Retention  (RetentionPolicy.CLASS)
41  public @interface OverrideMustInvoke {
42      When value() default When.ANYTIME;
43  
44  }
45

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags