blob: 9b3a83eaea3958f17d6346925101576ec1ebabbe (
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
163
164
|
/*******************************************************************************
* 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.common.core.utility.TextRange;
/**
* Corresponds to the JAXB annotation
* javax.xml.bind.annotation.XmlElementDecl
*
* 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 XmlElementDeclAnnotation
extends QNameAnnotation {
// ***** scope *****
/**
* String associated with "scope" property changes.
*/
String SCOPE_PROPERTY = "scope"; //$NON-NLS-1$
/**
* Corresponds to the 'scope' element of the XmlElementDecl annotation.
* Return null if the element does not exist in Java.
* Return the portion of the value preceding ".class".
* <pre>
* @XmlElementDecl(type=XmlElementDecl.GLOBAL.class)
* </pre>
* will return "XmlElementDecl.GLOBAL"
*/
String getScope();
/**
* Corresponds to the 'scope' element of the XmlElementDecl annotation.
* Set to null to remove the element.
*/
void setScope(String scope);
/**
* Return the {@link TextRange} for the 'scope' element. If the element
* does not exist return the {@link TextRange} for the XmlElementDecl annotation.
*/
TextRange getScopeTextRange(CompilationUnit astRoot);
/**
* String associated with "fullyQualifiedScopeClassName" property changes.
*/
String FULLY_QUALIFIED_SCOPE_CLASS_NAME_PROPERTY = "fullyQualifiedScopeClassName"; //$NON-NLS-1$
/**
* Return the fully-qualified scope class name as resolved by the AST's bindings.
* <pre>
* @XmlElementDecl(type=XmlElementDecl.GLOBAL.class)
* </pre>
* will return "javax.xml.bind.annotation.XmlElementDecl.GLOBAL"
*/
String getFullyQualifiedScopeClassName();
// ***** substitution head namespace *****
/**
* String associated with "substitutionHeadNamespace" property changes.
*/
String SUBSTITUTION_HEAD_NAMESPACE_PROPERTY = "substitutionHeadNamespace"; //$NON-NLS-1$
/**
* Corresponds to the 'substitutionHeadNamespace' element of the XmlElementDecl annotation.
* Return null if the element does not exist in Java.
*/
String getSubstitutionHeadNamespace();
/**
* Corresponds to the 'substitutionHeadNamespace' element of the XmlElementDecl annotation.
* Set to null to remove the element.
*/
void setSubstitutionHeadNamespace(String substitutionHeadNamespace);
/**
* Return the {@link TextRange} for the 'substitutionHeadNamespace' element. If the element
* does not exist return the {@link TextRange} for the XmlElementDecl annotation.
*/
TextRange getSubstitutionHeadNamespaceTextRange(CompilationUnit astRoot);
/**
* Return whether the specified position touches the 'substitutionHeadNamespace' element.
* Return false if the element does not exist.
*/
boolean substitutionHeadNamespaceTouches(int pos, CompilationUnit astRoot);
// ***** substitution head name *****
/**
* String associated with "substitutionHeadName" property changes.
*/
String SUBSTITUTION_HEAD_NAME_PROPERTY = "substitutionHeadName"; //$NON-NLS-1$
/**
* Corresponds to the 'substitutionHeadName' element of the XmlElementDecl annotation.
* Return null if the element does not exist in Java.
*/
String getSubstitutionHeadName();
/**
* Corresponds to the 'substitutionHeadName' element of the XmlElementDecl annotation.
* Set to null to remove the element.
*/
void setSubstitutionHeadName(String substitutionHeadName);
/**
* Return the {@link TextRange} for the 'substitutionHeadName' element. If the element
* does not exist return the {@link TextRange} for the XmlElementDecl annotation.
*/
TextRange getSubstitutionHeadNameTextRange(CompilationUnit astRoot);
/**
* Return whether the specified position touches the 'substitutionHeadName' element.
* Return false if the element does not exist.
*/
boolean substitutionHeadNameTouches(int pos, CompilationUnit astRoot);
// ***** default value *****
/**
* String associated with "defaultValue" property changes.
*/
String DEFAULT_VALUE_PROPERTY = "defaultValue"; //$NON-NLS-1$
/**
* Corresponds to the 'defaultValue' element of the XmlElementDecl annotation.
* Return null if the element does not exist in Java.
*/
String getDefaultValue();
/**
* Corresponds to the 'defaultValue' element of the XmlElementDecl 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 XmlElementDecl annotation.
*/
TextRange getDefaultValueTextRange(CompilationUnit astRoot);
}
|
