01: /*
02: * FindBugs - Find Bugs in Java programs
03: * Copyright (C) 2005-2006, University of Maryland
04: *
05: * This library is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU Lesser General Public
07: * License as published by the Free Software Foundation; either
08: * version 2.1 of the License, or (at your option) any later version.
09: *
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: package edu.umd.cs.findbugs.annotations;
20:
21: import java.lang.annotation.Documented;
22: import java.lang.annotation.ElementType;
23: import java.lang.annotation.Retention;
24: import java.lang.annotation.RetentionPolicy;
25: import java.lang.annotation.Target;
26:
27: /**
28: * Used to annotate a method that, if overridden, must (or should) be invoked
29: * by an invocation on super in the overriding method. Examples
30: * of such methods include finalize() and clone().
31: *
32: * The argument to the method indicates when the super invocation should
33: * occur: at any time, at the beginning of the overriding method, or at the end
34: * of the overriding method.
35: * @see edu.umd.cs.findbugs.annotations.When
36: **/
37: @Documented
38: @Target({ElementType.METHOD,ElementType.CONSTRUCTOR})
39: // added cons
40: @Retention(RetentionPolicy.CLASS)
41: // .CLASS
42: public @interface OverrideMustInvoke {
43: When value() default When.ANYTIME;
44:
45: }
|