blob: 965b90664087404d39168a680dff0bda8042e56e (
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
|
/*******************************************************************************
* Copyright (c) 2007, 2012 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.jpa.core.context.persistence;
import org.eclipse.jdt.core.IPackageFragment;
import org.eclipse.jdt.core.IType;
import org.eclipse.jpt.common.utility.internal.transformer.AbstractTransformer;
import org.eclipse.jpt.common.utility.transformer.Transformer;
import org.eclipse.jpt.jpa.core.JpaStructureNode;
import org.eclipse.jpt.jpa.core.context.PersistentType;
import org.eclipse.jpt.jpa.core.context.java.JavaPersistentType;
import org.eclipse.jpt.jpa.core.resource.persistence.XmlJavaClassRef;
import org.eclipse.text.edits.DeleteEdit;
import org.eclipse.text.edits.ReplaceEdit;
/**
* Context model corresponding to the XML resource model
* {@link XmlJavaClassRef}, which corresponds to the <code>class<code> element
* in the <code>persistence.xml</code> file.
* This is also used for "implied" class refs; i.e. class refs that are not
* explicitly listed in the <code>persistence.xml</code> file.
* <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.3
* @since 2.0
*/
public interface ClassRef
extends JpaStructureNode, PersistentType.Owner
{
/**
* Return whether the class ref is a reference to the specified type.
*/
boolean isFor(String typeName);
/**
* Return <code>true</code> if the mapping file ref is <em>virtual</em>;
* return <code>false</code> if the mapping file ref is represented by an
* entry in the <code>persistence.xml</code> file.
*/
boolean isVirtual();
/**
* Return the class ref's corresponding resource class ref.
* This is <code>null</code> for <em>implied</em> class refs.
*/
XmlJavaClassRef getXmlClassRef();
/**
* Return whether the text representation of this persistence unit contains
* the given text offset
*/
boolean containsOffset(int textOffset);
// ********** class name **********
/**
* String constant associated with changes to the class name
*/
final static String CLASS_NAME_PROPERTY = "className"; //$NON-NLS-1$
/**
* Return the class name of the class ref.
*/
String getClassName();
/**
* Set the class name of the class ref.
*/
void setClassName(String className);
// ********** java persistent type **********
/**
* String constant associated with changes to the java persistent type
*/
final static String JAVA_PERSISTENT_TYPE_PROPERTY = "javaPersistentType"; //$NON-NLS-1$
/**
* Return the JavaPersistentType that corresponds to this IClassRef.
* This can be null.
* This is not settable by users of this API.
*/
JavaPersistentType getJavaPersistentType();
Transformer<ClassRef, JavaPersistentType> JAVA_PERSISTENT_TYPE_TRANSFORMER = new JavaPersistentTypeTransformer();
class JavaPersistentTypeTransformer
extends AbstractTransformer<ClassRef, JavaPersistentType>
{
@Override
protected JavaPersistentType transform_(ClassRef ref) {
return ref.getJavaPersistentType();
}
}
// ********** refactoring **********
/**
* If this {@link #isFor(String)} the specified type,
* create a text delete edit for deleting the type mapping element and
* any text that precedes it.
* Otherwise return an empty collection.
*/
Iterable<DeleteEdit> createDeleteTypeEdits(IType type);
/**
* Create replace edits for renaming any references to
* the specified original type to the specified new name.
* The specified original type has not yet been renamed; and the specified
* new name is a "simple" (unqualified) name.
*/
Iterable<ReplaceEdit> createRenameTypeEdits(IType originalType, String newName);
/**
* Create replace edits for moving any references to
* the specified original type to the specified new package.
* The specified original type has not yet been moved.
*/
Iterable<ReplaceEdit> createMoveTypeEdits(IType originalType, IPackageFragment newPackage);
/**
* Create replace edits for renaming any references to
* the specified original package to the specified new name.
* The specified original package has not yet been renamed.
*/
Iterable<ReplaceEdit> createRenamePackageEdits(IPackageFragment originalPackage, String newName);
}
|
