blob: 359698287534c98cfd6a7c5526ee95482e53fc51 (
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
165
166
167
168
169
170
171
172
173
174
175
|
/*******************************************************************************
* 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;
import org.eclipse.jpt.common.utility.internal.iterables.ListIterable;
/**
* Corresponds to the JAXB annotation
* javax.xml.bind.annotation.XmlType
*
* 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 XmlTypeAnnotation
extends Annotation {
String ANNOTATION_NAME = JAXB.XML_TYPE;
/**
* Corresponds to the 'factoryClass' element of the XmlType annotation.
* Return null if the element does not exist in Java.
* Return the portion of the value preceding ".class".
* <pre>
* @XmlType(name="USAddressType", factoryClass=USAddressFactory.class)
* </pre>
* will return "USAddressFactory"
*/
String getFactoryClass();
String FACTORY_CLASS_PROPERTY = "factoryClass"; //$NON-NLS-1$
/**
* Corresponds to the 'factoryClass' element of the XmlType annotation.
* Set to null to remove the element.
*/
void setFactoryClass(String factoryClass);
/**
* Return the {@link TextRange} for the 'factoryClass' element. If the element
* does not exist return the {@link TextRange} for the XmlType annotation.
*/
TextRange getFactoryClassTextRange(CompilationUnit astRoot);
/**
* Return the fully-qualified factory class name as resolved by the AST's bindings.
* <pre>
* @XmlType(name="USAddressType", factoryClass=USAddressFactory.class)
* </pre>
* will return "model.USAddressFactory" if there is an import for model.USAddressFactory.
* @return
*/
String getFullyQualifiedFactoryClassName();
String FULLY_QUALIFIED_FACTORY_CLASS_NAME_PROPERTY = "fullyQualifiedFactoryClassName"; //$NON-NLS-1$
/**
* Corresponds to the 'factoryMethod' element of the XmlType annotation.
* Return null if the element does not exist in Java.
*/
String getFactoryMethod();
String FACTORY_METHOD_PROPERTY = "factoryMethod"; //$NON-NLS-1$
/**
* Corresponds to the 'factoryMethod' element of the XmlType annotation.
* Set to null to remove the element.
*/
void setFactoryMethod(String factoryMethod);
/**
* Return the {@link TextRange} for the 'factoryMethod' element. If the element
* does not exist return the {@link TextRange} for the XmlType annotation.
*/
TextRange getFactoryMethodTextRange(CompilationUnit astRoot);
/**
* Corresponds to the 'name' element of the XmlType 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 XmlType 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 XmlType annotation.
*/
TextRange getNameTextRange(CompilationUnit astRoot);
/**
* Return whether the specified position touches the 'name' element.
* Return false if the element does not exist.
*/
boolean nameTouches(int pos, CompilationUnit astRoot);
/**
* Corresponds to the 'namespace' element of the XmlType 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 XmlType 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 XmlType annotation.
*/
TextRange getNamespaceTextRange(CompilationUnit astRoot);
/**
* Return whether the specified position touches the 'namespace' element.
* Return false if the element does not exist.
*/
boolean namespaceTouches(int pos, CompilationUnit astRoot);
/**
* Corresponds to the 'propOrder' element of the XmlType annotation.
* Return an empty iterator if the element does not exist in Java.
*/
ListIterable<String> getPropOrder();
String PROP_ORDER_LIST = "propOrder"; //$NON-NLS-1$
/**
* Corresponds to the 'propOrder' element of the XmlType annotation.
*/
int getPropOrderSize();
/**
* Corresponds to the 'propOrder' element of the XmlType annotation.
*/
void addProp(String prop);
/**
* Corresponds to the 'propOrder' element of the XmlType annotation.
*/
void addProp(int index, String prop);
/**
* Corresponds to the 'propOrder' element of the XmlType annotation.
*/
void moveProp(int targetIndex, int sourceIndex);
/**
* Corresponds to the 'propOrder' element of the XmlType annotation.
*/
void removeProp(String prop);
/**
* Corresponds to the 'propOrder' element of the XmlType annotation.
*/
void removeProp(int index);
}
|
