blob: 360db4e6ab20cc49c85149a86c95d0cb875eb58d (
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
|
/*******************************************************************************
* 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.resource.java;
import org.eclipse.jpt.common.core.resource.java.Annotation;
import org.eclipse.jpt.common.core.utility.TextRange;
/**
* Corresponds to the JPA annotations:<code><ul>
* <li>javax.persistence.Column
* <li>javax.persistence.MapKeyColumn
* <li>javax.persistence.JoinColumn
* <li>javax.persistence.MapKeyJoinColumn
* <li>javax.persistence.DiscriminatorColumn
* <li>javax.persistence.OrderColumn
* <li>javax.persistence.PrimaryKeyJoinColumn
* </ul></code>
* 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.0
*/
public interface NamedColumnAnnotation
extends Annotation
{
/**
* Return whether the annotation exists in Java.
*/
boolean isSpecified();
// ********** name **********
/**
* Corresponds to the 'name' element of the *Column annotation.
* Return null if the element does not exist in Java.
*/
String getName();
String NAME_PROPERTY = "name"; //$NON-NLS-1$
/**
* Corresponds to the 'name' element of the *Column annotation.
* Set to null to remove the element.
*/
void setName(String name);
/**
* Return the {@link TextRange} for the 'name' element. If the element
* does not exist return the {@link TextRange} for the *Column annotation.
*/
TextRange getNameTextRange();
/**
* Return whether the specified position touches the 'name' element.
* Return false if the element does not exist.
*/
boolean nameTouches(int pos);
// ********** column definition **********
/**
* Corresponds to the 'columnDefinition' element of the *Column annotation.
* Return null if the element does not exist in Java.
*/
String getColumnDefinition();
String COLUMN_DEFINITION_PROPERTY = "columnDefinition"; //$NON-NLS-1$
/**
* Corresponds to the 'columnDefinition' element of the *Column annotation.
* Set to null to remove the element.
*/
void setColumnDefinition(String columnDefinition);
/**
* Return the {@link TextRange} for the 'columnDefinition' element. If the
* element does not exist return the {@link TextRange} for the *Column annotation.
*/
TextRange getColumnDefinitionTextRange();
}
|
