blob: cfcf848ae6a99e74458d7926abc8e289d455783b (
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
/*******************************************************************************
* 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.jpa2.resource.java;
import java.util.ListIterator;
import org.eclipse.jpt.jpa.core.resource.java.Annotation;
/**
* Corresponds to the Java 6 annotation
* <code>javax.annotation.Generated</code>
* <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.3
*/
public interface GeneratedAnnotation
extends Annotation
{
String ANNOTATION_NAME = "javax.annotation.Generated"; // requires JRE 1.6 //$NON-NLS-1$
String VALUE_ELEMENT_NAME = "value"; //$NON-NLS-1$
String DATE_ELEMENT_NAME = "date"; //$NON-NLS-1$
String COMMENTS_ELEMENT_NAME = "comments"; //$NON-NLS-1$
/**
* Corresponds to the <code>value<code> element of the <code>Generated</code>
* annotation.
* Return <code>null</code> if the element does not exist in the annotation.
*/
ListIterator<String> values();
String VALUES_LIST = "values"; //$NON-NLS-1$
/**
* Corresponds to the <code>value<code> element of the <code>Generated</code>
* annotation.
*/
int valuesSize();
/**
* Corresponds to the <code>value<code> element of the <code>Generated</code>
* annotation.
*/
String getValue(int index);
/**
* Corresponds to the <code>value<code> element of the <code>Generated</code>
* annotation.
*/
void addValue(String value);
/**
* Corresponds to the <code>value<code> element of the <code>Generated</code>
* annotation.
*/
void addValue(int index, String value);
/**
* Corresponds to the <code>value<code> element of the <code>Generated</code>
* annotation.
*/
void moveValue(int targetIndex, int sourceIndex);
/**
* Corresponds to the <code>value<code> element of the <code>Generated</code>
* annotation.
*/
void removeValue(String value);
/**
* Corresponds to the <code>value<code> element of the <code>Generated</code>
* annotation.
*/
void removeValue(int index);
/**
* Corresponds to the <code>date</code> element of the <code>Generated</code>
* annotation.
* Return <code>null</code> if the element does not exist in the annotation.
*/
String getDate();
String DATE_PROPERTY = "date"; //$NON-NLS-1$
/**
* Corresponds to the <code>date</code> element of the <code>Generated</code>
* annotation.
* Set to <code>null</code> to remove the element.
*/
void setDate(String date);
/**
* Corresponds to the <code>comments</code> element of the <code>Generated</code>
* annotation.
* Return <code>null</code> if the element does not exist in the annotation.
*/
String getComments();
String COMMENTS_PROPERTY = "comments"; //$NON-NLS-1$
/**
* Corresponds to the <code>comments</code> element of the <code>Generated</code>
* annotation.
* Set to <code>null</code> to remove the element.
*/
void setComments(String comments);
}
|
