blob: a4cd5e03520861e592ef86ce0e46dcc39124483b (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2010, 2011 Oracle. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0, which accompanies this distribution
* and is available at http://www.eclipse.org/legal/epl-v10.html.
*
* Contributors:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.common.core.resource.java;
import org.eclipse.jdt.core.dom.CompilationUnit;
/**
* Common Java resource annotation behavior
*
* Provisional API: This interface is part of an interim API that is still
* under development and expected to change significantly before reaching
* stability. It is available at this early stage to solicit feedback from
* pioneering adopters on the understanding that any code that uses this API
* will almost certainly be broken (repeatedly) as the API evolves.
*
* @version 3.0
* @since 3.0
*/
public interface Annotation
extends JavaResourceNode
{
/**
* Return the annotation's fully qualified name, as opposed to the value of
* the annotation's 'name' element. For example:
* @com.foo.Bar(name="Thomas")
* #getAnnotationName() will return "com.foo.Bar".
* In typical subclasses, #getName() would return "Thomas".
*/
String getAnnotationName();
/**
* Return the corresponding JDT DOM annotation from the specified
* AST compilation unit.
*/
org.eclipse.jdt.core.dom.Annotation getAstAnnotation(CompilationUnit astRoot);
/**
* Create and add the corresponding Java annotation to the JDT DOM.
*/
void newAnnotation();
/**
* Remove the corresponding Java annotation from the JDT DOM.
*/
void removeAnnotation();
/**
* Return whether all the annotation's member values are <code>null</code>;
* implying the annotation can be removed if it has no semantic value as a
* marker annotation.
*/
boolean isUnset();
}
|