blob: e2afac33e74344aac42b654edef227b895120dbc (
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
|
/*******************************************************************************
* Copyright (c) 2007, 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.core.resource.java;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jpt.core.utility.TextRange;
/**
* Common protocol among
* javax.persistence.JoinColumn
* javax.persistence.MapKeyJoinColumn
*
* 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 BaseJoinColumnAnnotation
extends BaseColumnAnnotation
{
/**
* Corresponds to the 'referencedColumnName' element of the JoinColumn annotation.
* Return null if the element does not exist in Java.
*/
String getReferencedColumnName();
String REFERENCED_COLUMN_NAME_PROPERTY = "referencedColumnName"; //$NON-NLS-1$
/**
* Corresponds to the 'referencedColumnName' element of the JoinColumn annotation.
* Set to null to remove the element.
*/
void setReferencedColumnName(String referencedColumnName);
/**
* Return the {@link TextRange} for the 'referencedColumnName' element. If element
* does not exist return the {@link TextRange} for the JoinColumn annotation.
*/
TextRange getReferencedColumnNameTextRange(CompilationUnit astRoot);
/**
* Return whether the specified position touches the 'referencedColumnName' element.
* Return false if the element does not exist.
*/
boolean referencedColumnNameTouches(int pos, CompilationUnit astRoot);
}
|
