blob: 386fdd36ed9e4543f2517dbba90db18e1a4ca85f (
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
|
/*******************************************************************************
* Copyright (c) 2007, 2009 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.core.resource.java;
import java.util.Iterator;
import java.util.ListIterator;
import org.eclipse.jpt.utility.MethodSignature;
/**
* Java source code or binary persistent attribute (field or property)
*
* 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.
*/
//TODO handle:
// @Basic
// private String foo, bar;
public interface JavaResourcePersistentAttribute
extends JavaResourcePersistentMember
{
/**
* The Java resource persistent attribute's name does not change.
*/
String getName();
/**
* Return a null annotation for the specified annotation name.
* Return null if the specified annotation name is null.
* The corresponding AnnotationDefinition must implement #buildNullAnnotation()
* {@link AnnotationDefinition#buildNullAnnotation(JavaResourcePersistentMember,
* org.eclipse.jpt.core.utility.jdt.Member)}
*/
Annotation getNullAnnotation(String annotationName);
/**
* Whether the Java resource persistent attribute is a field does not change.
*/
boolean isField();
/**
* Whether the Java resource persistent attribute is a property does not change.
*/
boolean isProperty();
/**
* Return the access type explicitly specified by the javax.persistence.Access annotation.
* Return null if the Access annotation is not present.
* For JPA 1.0 this is always going to return null; Access annotation is not supported in 1.0.
*/
AccessType getSpecifiedAccess();
/**
* Return whether the attribute's type implements or extends the specified
* type.
*/
boolean typeIsSubTypeOf(String typeName);
/**
* Return whether the attribute's type is a "variable" primitive type
* (i.e. any primitive type except 'void').
*/
boolean typeIsVariablePrimitive();
/**
* Return whether the Java resource persistent attribute is for the specified
* method.
*/
boolean isFor(MethodSignature methodSignature, int occurrence);
/**
* @see java.lang.reflect.Modifier
*/
int getModifiers();
String MODIFIERS_PROPERTY = "modifiers"; //$NON-NLS-1$
/**
* Return the resolved, qualified name of the attribute's type
* (e.g. "java.util.Collection" or "byte[]").
* If the type is an array, this name will include the appropriate number
* of bracket pairs.
* This name will not include the type's generic type arguments
* (e.g. "java.util.Collection<java.lang.String>").
* @see #typeTypeArgumentNames()
*/
String getTypeName();
String TYPE_NAME_PROPERTY = "typeName"; //$NON-NLS-1$
/**
* Return whether the attribute type is an interface.
*/
boolean typeIsInterface();
String TYPE_IS_INTERFACE_PROPERTY = "typeIsInterface"; //$NON-NLS-1$
/**
* Return whether the attribute type is an enum.
*/
boolean typeIsEnum();
String TYPE_IS_ENUM_PROPERTY = "typeIsEnum"; //$NON-NLS-1$
/**
* Return the names of the attribute type's superclasses.
*/
ListIterator<String> typeSuperclassNames();
String TYPE_SUPERCLASS_NAMES_COLLECTION = "typeSuperclassNames"; //$NON-NLS-1$
/**
* Return the names of the attribute type's interfaces.
*/
Iterator<String> typeInterfaceNames();
String TYPE_INTERFACE_NAMES_COLLECTION = "typeInterfaceNames"; //$NON-NLS-1$
/**
* Return the names of the attribute type's type arguments.
* The name for any argument that is an array will contain the appropriate
* number of bracket pairs.
* The names will not include any further generic type arguments.
*/
ListIterator<String> typeTypeArgumentNames();
String TYPE_TYPE_ARGUMENT_NAMES_COLLECTION = "typeTypeArgumentNames"; //$NON-NLS-1$
int typeTypeArgumentNamesSize();
String getTypeTypeArgumentName(int index);
}
|
