blob: e948cf1b70ed65d163b1315f7b348137c24da3f9 (
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
|
/*******************************************************************************
* Copyright (c) 2007, 2008 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;
/**
* Corresponds to the javax.persistence.QueryHint annotation
*
* 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.
*/
public interface QueryHintAnnotation extends JavaResourceNode
{
String ANNOTATION_NAME = JPA.QUERY_HINT;
/**
* Corresponds to the name element of the QueryHint annotation.
* Returns null if the name valuePair does not exist in the annotation
*/
String getName();
/**
* Corresponds to the name element of the QueryHint annotation.
* Setting to null will remove the name valuePair
*/
void setName(String name);
String NAME_PROPERTY = "nameProperty";
/**
* Corresponds to the value element of the QueryHint annotation.
* Returns null if the value valuePair does not exist in the annotation
*/
String getValue();
/**
* Corresponds to the value element of the QueryHint annotation.
* Setting to null will remove the value valuePair
*/
void setValue(String value);
String VALUE_PROPERTY = "valueProperty";
/**
* Return the {@link TextRange} for the name element. If the name element
* does not exist return the {@link TextRange} for the QueryHint annotation.
*/
TextRange getNameTextRange(CompilationUnit astRoot);
/**
* Return the {@link TextRange} for the value element. If the value element
* does not exist return the {@link TextRange} for the QueryHint annotation.
*/
TextRange getValueTextRange(CompilationUnit astRoot);
}
|
