1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
/*
* Copyright (C) 2009-2012 The Project Lombok Authors.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package lombok.eclipse;
import lombok.core.AnnotationValues;
import lombok.core.SpiLoadUtil;
/**
* Implement this interface if you want to be triggered for a specific annotation.
*
* You MUST replace 'T' with a specific annotation type, such as:
*
* {@code public class HandleGetter extends EclipseAnnotationHandler<Getter>}
*
* Because this generics parameter is inspected to figure out which class you're interested in.
*
* You also need to register yourself via SPI discovery as being an implementation of {@code EclipseAnnotationHandler}.
*/
public abstract class EclipseAnnotationHandler<T extends java.lang.annotation.Annotation> {
/**
* Called when an annotation is found that is likely to match the annotation you're interested in.
*
* Be aware that you'll be called for ANY annotation node in the source that looks like a match. There is,
* for example, no guarantee that the annotation node belongs to a method, even if you set your
* TargetType in the annotation to methods only.
*
* @param annotation The actual annotation - use this object to retrieve the annotation parameters.
* @param ast The Eclipse AST node representing the annotation.
* @param annotationNode The Lombok AST wrapper around the 'ast' parameter. You can use this object
* to travel back up the chain (something javac AST can't do) to the parent of the annotation, as well
* as access useful methods such as generating warnings or errors focused on the annotation.
*/
public abstract void handle(AnnotationValues<T> annotation, org.eclipse.jdt.internal.compiler.ast.Annotation ast, EclipseNode annotationNode);
/**
* Called when you want to defer until post diet, and we're still in pre-diet. May be called not at all or multiple times, so make sure
* this method is idempotent if run more than once, and whatever you do here should also be done in the main 'handle' method.
*
* NB: This method exists because in certain cases, within eclipse, you have to create i.e. a field before referencing it in generated code. You still
* have to create the field, if its not already there, in 'handle', because for example preHandle would never even be called in ecj mode.
*/
public void preHandle(AnnotationValues<T> annotation, org.eclipse.jdt.internal.compiler.ast.Annotation ast, EclipseNode annotationNode) {
}
/**
* This handler is a handler for the given annotation; you don't normally need to override this class
* as the annotation type is extracted from your {@code extends EclipseAnnotationHandler<AnnotationTypeHere>}
* signature.
*/
@SuppressWarnings("unchecked") public Class<T> getAnnotationHandledByThisHandler() {
return (Class<T>) SpiLoadUtil.findAnnotationClass(getClass(), EclipseAnnotationHandler.class);
}
}
|
