blob: 8b80d91857b4712341a462ebae84d8148c482388 (
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
|
/*******************************************************************************
* Copyright (c) 2010, 2011 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.context;
import java.util.List;
import org.eclipse.jpt.common.core.resource.java.JavaResourceAbstractType;
import org.eclipse.jpt.jaxb.core.context.java.JavaContextNode;
import org.eclipse.wst.validation.internal.provisional.core.IMessage;
import org.eclipse.wst.validation.internal.provisional.core.IReporter;
/**
* Represents a java class (or enum or interface) with JAXB metadata (specified or implied).
* <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 3.0
* @since 3.0
*/
public interface JaxbType
extends JavaContextNode {
/**
* Return the kind of JaxbType this represents
*/
Kind getKind();
/**
* Return the associated java resource type
*/
JavaResourceAbstractType getJavaResourceType();
/**
* Returns the fully qualified name of this type, including qualification for any
* enclosing types and packages.
*/
String getFullyQualifiedName();
/**
* Returns the type-qualified name of this type, including qualification for any
* enclosing types, but not including package qualification.
*/
String getTypeQualifiedName();
/**
* Return the name of the type without any package or type qualifiers
*/
String getSimpleName();
/**
* Return the name of the type's package. Empty string if none.
*/
String getPackageName();
/**
* Return the {@link JaxbPackage} associated with this type
*/
JaxbPackage getJaxbPackage();
/**
* Return all directly referenced types, fully qualified.
* (Used for constructing Jaxb context)
*/
Iterable<String> getDirectlyReferencedTypeNames();
// **************** validation ********************************************
/**
* Add to the list of current validation messages
*/
void validate(List<IMessage> messages, IReporter reporter);
/**
* The kind of metadata specified on the java type.
*/
public static enum Kind {
/**
* A JaxbType of {@link Kind} PERSISTENT_CLASS may safely be cast as a {@link JaxbPersistentClass}
*/
PERSISTENT_CLASS,
/**
* A JaxbType of {@link Kind} PERSISTENT_ENUM may safely be cast as a {@link JaxbPersistentEnum}
*/
PERSISTENT_ENUM,
/**
* A JaxbType of {@link Kind} REGISTRY may safely be cast as a {@link JaxbRegistry}
*/
REGISTRY,
/**
* A JaxbType of {@link Kind} TRANSIENT may safely be cast as a {@link JaxbTransientClass}
*/
TRANSIENT
}
}
|
