blob: 7cdba6a3f4a2ab76683559477143a79499349873 (
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/*******************************************************************************
* Copyright (c) 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.jaxb.core.resource.java;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jpt.core.resource.java.NestableAnnotation;
import org.eclipse.jpt.core.utility.TextRange;
/**
* Corresponds to the JAXB annotation
* javax.xml.bind.annotation.XmlElement
*
* 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 XmlElementAnnotation
extends NestableAnnotation
{
String ANNOTATION_NAME = JAXB.XML_ELEMENT;
/**
* Corresponds to the 'name' element of the XmlElement annotation.
* Return null if the element does not exist in Java.
*/
String getName();
String NAME_PROPERTY = "name"; //$NON-NLS-1$
/**
* Corresponds to the 'name' element of the XmlElement annotation.
* Set to null to remove the element.
*/
void setName(String name);
/**
* Return the {@link TextRange} for the 'name' element. If the element
* does not exist return the {@link TextRange} for the XmlElement annotation.
*/
TextRange getNameTextRange(CompilationUnit astRoot);
/**
* Corresponds to the 'namespace' element of the XmlElement annotation.
* Return null if the element does not exist in Java.
*/
String getNamespace();
String NAMESPACE_PROPERTY = "namespace"; //$NON-NLS-1$
/**
* Corresponds to the 'namespace' element of the XmlElement annotation.
* Set to null to remove the element.
*/
void setNamespace(String namespace);
/**
* Return the {@link TextRange} for the 'namespace' element. If the element
* does not exist return the {@link TextRange} for the XmlElement annotation.
*/
TextRange getNamespaceTextRange(CompilationUnit astRoot);
/**
* Corresponds to the 'defaultValue' element of the XmlElement annotation.
* Return null if the element does not exist in Java.
*/
String getDefaultValue();
String DEFAULT_VALUE_PROPERTY = "defaultValue"; //$NON-NLS-1$
/**
* Corresponds to the 'defaultValue' element of the XmlElement annotation.
* Set to null to remove the element.
*/
void setDefaultValue(String defaultValue);
/**
* Return the {@link TextRange} for the 'defaultValue' element. If the element
* does not exist return the {@link TextRange} for the XmlElement annotation.
*/
TextRange getDefaultValueTextRange(CompilationUnit astRoot);
/**
* Corresponds to the 'nillable' element of the XmlElement annotation.
* Return null if the element does not exist in Java.
*/
Boolean getNillable();
String NILLABLE_PROPERTY = "nillable"; //$NON-NLS-1$
/**
* Corresponds to the 'nillable' element of the XmlElement annotation.
* Set to null to remove the element.
*/
void setNillable(Boolean nillable);
/**
* Return the {@link TextRange} for the 'nillable' element. If the element
* does not exist return the {@link TextRange} for the XmlElement annotation.
*/
TextRange getNillableTextRange(CompilationUnit astRoot);
/**
* Corresponds to the 'required' element of the XmlElement annotation.
* Return null if the element does not exist in Java.
*/
Boolean getRequired();
String REQUIRED_PROPERTY = "required"; //$NON-NLS-1$
/**
* Corresponds to the 'required' element of the XmlElement annotation.
* Set to null to remove the element.
*/
void setRequired(Boolean required);
/**
* Return the {@link TextRange} for the 'required' element. If the element
* does not exist return the {@link TextRange} for the XmlElement annotation.
*/
TextRange getRequiredTextRange(CompilationUnit astRoot);
/**
* Corresponds to the 'type' element of the XmlElement annotation.
* Return null if the element does not exist in Java.
* Return the portion of the value preceding ".class".
* <pre>
* @XmlElement(type=Foo.class)
* </pre>
* will return "Foo"
*/
String getType();
String TYPE_PROPERTY = "type"; //$NON-NLS-1$
/**
* Corresponds to the 'type' element of the XmlElement annotation.
* Set to null to remove the element.
*/
void setType(String type);
/**
* Return the {@link TextRange} for the 'type' element. If the element
* does not exist return the {@link TextRange} for the XmlElement annotation.
*/
TextRange getTypeTextRange(CompilationUnit astRoot);
/**
* Return the fully-qualified type name as resolved by the AST's bindings.
* <pre>
* @XmlElement(type=Foo.class)
* </pre>
* will return "model.Foo" if there is an import for model.Foo.
* @return
*/
String getFullyQualifiedTypeName();
String FULLY_QUALIFIED_TYPE_NAME_PROPERTY = "fullyQualifiedTypeName"; //$NON-NLS-1$
}
|
