blob: 3abc2cdead7923b2f01f1e280a9567f3261685fb (
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
|
/*******************************************************************************
* 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.resource.java.NestableAnnotation;
import org.eclipse.jpt.common.core.utility.TextRange;
/**
* Corresponds to the JAXB annotation
* javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter
*
* 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 XmlJavaTypeAdapterAnnotation
extends NestableAnnotation {
/**
* Corresponds to the 'value' element of the XmlJavaTypeAdapter annotation.
* Return null if the element does not exist in Java.
* Return the portion of the value preceding ".class".
* <pre>
* @XmlJavaTypeAdapter(value=FooAdapter.class)
* </pre>
* will return "FooAdapter"
*/
String getValue();
String VALUE_PROPERTY = "value"; //$NON-NLS-1$
/**
* Corresponds to the 'value' element of the XmlJavaTypeAdapter annotation.
* Set to null to remove the element.
*/
void setValue(String value);
/**
* Return the {@link TextRange} for the 'value' element. If the element
* does not exist return the {@link TextRange} for the XmlJavaTypeAdapter annotation.
*/
TextRange getValueTextRange(CompilationUnit astRoot);
/**
* Return the value's fully-qualified class name as resolved by the AST's bindings.
* <pre>
* @XmlJavaTypeAdapter(FooAdapter.class)
* </pre>
* will return "example.FooAdapter" if there is an import for example.FooAdapter.
*/
String getFullyQualifiedValue();
String FULLY_QUALIFIED_VALUE_PROPERTY = "fullyQualifiedValue"; //$NON-NLS-1$
/**
* Corresponds to the 'type' element of the XmlJavaTypeAdapter annotation.
* Return null if the element does not exist in Java.
* Return the portion of the value preceding ".class".
* <pre>
* @XmlJavaTypeAdapter(type=Foo.class)
* </pre>
* will return "Foo"
*/
String getType();
String TYPE_PROPERTY = "type"; //$NON-NLS-1$
/**
* Corresponds to the 'type' element of the XmlJavaTypeAdapter 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 XmlJavaTypeAdapter annotation.
*/
TextRange getTypeTextRange(CompilationUnit astRoot);
/**
* Return the type's fully-qualified class name as resolved by the AST's bindings.
* <pre>
* @XmlJavaTypeAdapter(type=Foo.class)
* </pre>
* will return "example.Foo" if there is an import for example.Foo.
*/
String getFullyQualifiedType();
String FULLY_QUALIFIED_TYPE_PROPERTY = "fullyQualifiedType"; //$NON-NLS-1$
}
|