blob: 63c480bb7ae595cbd34dd3eb893f3faf25a4f999 (
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
|
/*******************************************************************************
* 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.jpa.core.context.java;
import java.util.ListIterator;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jpt.common.core.utility.TextRange;
import org.eclipse.jpt.jpa.core.context.OverrideContainer;
import org.eclipse.jpt.jpa.core.context.Override_;
import org.eclipse.jpt.jpa.core.context.VirtualOverride;
import org.eclipse.jpt.jpa.core.resource.java.JavaResourcePersistentMember;
/**
* Java attribute or association override container
* <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 2.3
* @since 2.3
*/
public interface JavaOverrideContainer
extends OverrideContainer, JavaJpaContextNode
{
ListIterator<? extends JavaReadOnlyOverride> overrides();
JavaReadOnlyOverride getOverrideNamed(String name);
ListIterator<? extends JavaOverride> specifiedOverrides();
JavaOverride getSpecifiedOverride(int index);
JavaOverride getSpecifiedOverrideNamed(String name);
ListIterator<? extends JavaVirtualOverride> virtualOverrides();
JavaVirtualOverride convertOverrideToVirtual(Override_ specifiedOverride);
JavaOverride convertOverrideToSpecified(VirtualOverride virtualOverride);
/**
* JPA 2.0
* <p>
* Return a prefix (<em>without</em> the following <code>'.'</code>)
* that may be prepended to the override name.
* Return <code>null</code> if no prefix is supported.
*/
String getPossiblePrefix();
String getWritePrefix();
// ********** owner **********
interface Owner
extends OverrideContainer.Owner
{
JavaResourcePersistentMember getResourcePersistentMember();
TextRange getValidationTextRange(CompilationUnit astRoot);
/**
* JPA 2.0
* <p>
* Return the prefix (<em>without</em> the following <code>'.'</code>)
* to be prepended to the override name.
*/
String getWritePrefix();
/**
* JPA 2.0
* <p>
* Return a prefix (<em>without</em> the following <code>'.'</code>)
* that may be prepended to the override name.
* Return <code>null</code> if no prefix is supported.
* <p>
* JPA 2.0 supports the prefixes <code>"value"</code> and <code>"key"</code>.
*/
String getPossiblePrefix();
/**
* JPA 2.0
* <p>
* This is necessary for JPA 2.0 because an override annotation for an
* element collection can have a name with a prefix that indicates
* whether the override applies to element collection's embedded key or
* value. Return whether the specified override name, which may have a
* prefix, is relevant to the override container.
* <p>
* JPA 2.0 supports the prefixes <code>"value"</code> and <code>"key"</code>.
*/
boolean isRelevant(String overrideName);
}
}
|
