diff options
Diffstat (limited to 'jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/resource/java/Annotation.java')
| -rw-r--r-- | jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/resource/java/Annotation.java | 33 |
1 files changed, 21 insertions, 12 deletions
diff --git a/jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/resource/java/Annotation.java b/jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/resource/java/Annotation.java index 7e115e6bac..ff1779a29c 100644 --- a/jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/resource/java/Annotation.java +++ b/jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/resource/java/Annotation.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007, 2008 Oracle. All rights reserved. + * Copyright (c) 2007, 2009 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. @@ -12,7 +12,7 @@ package org.eclipse.jpt.core.resource.java; import org.eclipse.jdt.core.dom.CompilationUnit; /** - * + * Common Java resource annotation behavior * * Provisional API: This interface is part of an interim API that is still * under development and expected to change significantly before reaching @@ -20,24 +20,33 @@ import org.eclipse.jdt.core.dom.CompilationUnit; * pioneering adopters on the understanding that any code that uses this API * will almost certainly be broken (repeatedly) as the API evolves. */ -public interface Annotation extends JavaResourceNode -{ +public interface Annotation + extends JavaResourceNode +{ /** - * Return the fully qualified annotation name. + * Return the annotation's fully qualified name, as opposed to the value of + * the annotation's 'name' element. For example: + * @com.foo.Bar(name="Thomas") + * #getAnnotationName() will return "com.foo.Bar". + * In typical subclasses, #getName() would return "Thomas". * @see JPA */ String getAnnotationName(); - - org.eclipse.jdt.core.dom.Annotation getJdtAnnotation(CompilationUnit astRoot); - + /** - * Removing the underyling Java annotation + * Return the corresponding JDT DOM annotation from the specified + * AST compilation unit. */ - void removeAnnotation(); + org.eclipse.jdt.core.dom.Annotation getJdtAnnotation(CompilationUnit astRoot); /** - * Create and add Java annotation + * Create and add the corresponding Java annotation to the JDT DOM. */ void newAnnotation(); - + + /** + * Remove the corresponding Java annotation from the JDT DOM. + */ + void removeAnnotation(); + } |