1 /*
2 * Copyright (c) 2007, James Leigh All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * - Redistributions of source code must retain the above copyright notice, this
8 * list of conditions and the following disclaimer.
9 * - Redistributions in binary form must reproduce the above copyright notice,
10 * this list of conditions and the following disclaimer in the documentation
11 * and/or other materials provided with the distribution.
12 * - Neither the name of the openrdf.org nor the names of its contributors may
13 * be used to endorse or promote products derived from this software without
14 * specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 *
28 */
29 package org.openrdf.elmo.annotations;
30
31 import java.lang.annotation.ElementType;
32 import java.lang.annotation.Retention;
33 import java.lang.annotation.RetentionPolicy;
34 import java.lang.annotation.Target;
35
36 /**
37 * Used on methods that intercept another method invocation. Placed on methods
38 * that take an {@link InvocationContext} as the parameter. This method will be
39 * called around the original method invocation.
40 * <ul>
41 * <li><b>name</b> regular expression that must match the entire method name.</li>
42 * <li><b>parameterType</b> list of parameterTypes were each given type
43 * {@link Class#isAssignableFrom(Class)} the method parameter type</li>
44 * <li><b>returnType</b> the method return type must be
45 * {@link Class#isAssignableFrom(Class)} the given type</li>
46 * <li><b>declaringClass</b> the method must be declared in the given class or
47 * one of its super classes</li>
48 * <li><b>conditionMethod</b> the name of a static method declared in the same
49 * class, with a return type of boolean and a parameter of type Method. Methods
50 * will only be intercepted if the given method returns true.</li>
51 * </ul>
52 *
53 * @author James Leigh
54 *
55 */
56 @Retention(RetentionPolicy.RUNTIME)
57 @Target(ElementType.METHOD)
58 public @interface intercepts {
59 String method() default "";
60
61 int argc() default -1;
62
63 Class<?>[] parameters() default { intercepts.class };
64
65 Class<?> returns() default intercepts.class;
66
67 Class<?> declaring() default intercepts.class;
68
69 String conditional() default "";
70 }