blob: 9005f36be09cbb8e0d8891f400205ab5f7ad1cb0 (
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
|
/*******************************************************************************
* Copyright (c) 2008, 2011 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.eclipselink.core.resource.java;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jpt.common.core.resource.java.Annotation;
import org.eclipse.jpt.common.core.utility.TextRange;
/**
* Corresponds to the EclipseLink annotation
* org.eclipse.persistence.annotations.Customizer
*
* 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.1
*/
public interface EclipseLinkCustomizerAnnotation
extends Annotation
{
String ANNOTATION_NAME = EclipseLink.CUSTOMIZER;
/**
* Corresponds to the 'value' element of the Customizer annotation.
* Return null if the element does not exist in Java.
*/
String getValue();
String VALUE_PROPERTY = "value"; //$NON-NLS-1$
/**
* Corresponds to the 'value' element of the Customizer annotation.
* Set to null to remove the element.
*/
void setValue(String value);
/**
* Return the fully-qualified customizer class name as resolved by the
* AST's bindings.
* <pre>
* @Customizer(EmployeeCustomizer.class)
* </pre>
* will return <code>"model.EmployeeCustomizer"</code> if there is an
* import for <code>model.EmployeeCustomizer</code>.
*/
String getFullyQualifiedCustomizerClassName();
/**
* Return the {@link TextRange} for the 'value' element. If the element
* does not exist return the {@link TextRange} for the Customizer annotation.
*/
TextRange getValueTextRange(CompilationUnit astRoot);
/**
* Return whether the customizer class implements the specified interface.
* @see org.eclipse.jpt.jpa.eclipselink.core.context.EclipseLinkCustomizer#ECLIPSELINK_DESCRIPTOR_CUSTOMIZER_CLASS_NAME
*/
boolean customizerClassImplementsInterface(String interfaceName, CompilationUnit astRoot);
}
|
