blob: 20f9997aae095f5cc59b445ec6f1fdaf90b55d52 (
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
/*******************************************************************************
* Copyright (c) 2009, 2010 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.jpa.core.resource.java;
import org.eclipse.jdt.core.dom.CompilationUnit;
/**
* Common behavior for all annotation "containers".
* This interface is used mainly in
* {@link org.eclipse.jpt.jpa.core.internal.resource.java.source.AnnotationContainerTools}.
* <p>
* 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 2.3
* @since 2.2
*/
public interface AnnotationContainer<T extends NestableAnnotation>
{
/**
* Return the corresponding JDT DOM annotation from the specified
* AST compilation unit. Used as a starting point when traversing the AST.
*/
org.eclipse.jdt.core.dom.Annotation getAstAnnotation(CompilationUnit astRoot);
/**
* Return the name of the container annotation's element that is used
* to indicate the nested annotations (typically <code>"value"</code>).
* Used when traversing the AST.
*/
String getElementName();
/**
* Return the name of the nested annotations held by the container.
* Used when traversing the AST.
*/
String getNestedAnnotationName();
/**
* Return the nested annotations held by the container.
*/
Iterable<T> getNestedAnnotations();
/**
* Return the number of nested annotations held by the container.
*/
int getNestedAnnotationsSize();
/**
* Add a nested annotation to the container
* without firing change notification.
*/
T addNestedAnnotation();
/**
* The specified JDT DOM annotation was added to the JDT DOM annotation
* corresponding to the container. Add a corresponding nested annotation
* to the container and notify interested parties.
*/
void syncAddNestedAnnotation(org.eclipse.jdt.core.dom.Annotation astAnnotation);
/**
* Move the nested annotation at the specified source index in the
* container to the specified target index without firing change notification.
* Return the moved nested annotation.
*/
T moveNestedAnnotation(int targetIndex, int sourceIndex);
/**
* Remove the nested annotation at the specified index from the
* container without firing change notification.
*/
T removeNestedAnnotation(int index);
/**
* The JDT DOM annotations starting at the specified index were removed
* from the JDT DOM annotations corresponding to the container.
* Remove the corresponding nested annotations from the
* container and notify interested parties.
*/
void syncRemoveNestedAnnotations(int index);
}
|
