| /******************************************************************************* |
| * 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. |
| * |
| * Contributors: |
| * Oracle - initial API and implementation |
| ******************************************************************************/ |
| package org.eclipse.jpt.core.resource.java; |
| |
| import org.eclipse.jdt.core.IAnnotation; |
| import org.eclipse.jpt.core.utility.jdt.Member; |
| |
| /** |
| * Used to build Annotations discovered in the Java source code. |
| * To provide new AnnotationDefinitions, create a new JpaPlatform |
| * by implementing JpaPlatform and/or extending GenericJpaPlatform. |
| * |
| * @see Annotation |
| * @see org.eclipse.jpt.core.JpaPlatform |
| * @see org.eclipse.jpt.core.internal.GenericJpaPlatform |
| * |
| * 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 AnnotationDefinition |
| { |
| /** |
| * Return the name of the annotation the definition will build in the |
| * various #build...(...) methods. |
| */ |
| String getAnnotationName(); |
| |
| /** |
| * Build and return an annotation for the specified member. |
| */ |
| Annotation buildAnnotation(JavaResourcePersistentMember parent, Member member); |
| |
| /** |
| * Build and return an annotation for the specified JDT annotation |
| * on the specified member. |
| */ |
| Annotation buildAnnotation(JavaResourcePersistentMember parent, IAnnotation jdtAnnotation); |
| |
| /** |
| * Build and return a "null" annotation for the specified member. |
| * Only certain annotations are required to have "null" implementations; |
| * typically the annotations with reasonably complex default behavior. |
| * The "null" annotation is used by the corresponding default context model. |
| * The "null" annotation simplifies the context model code, allowing the |
| * context model to simply set various bits of state (e.g. 'name') and the |
| * "null" annotation will create a new "real" annotation and forward the |
| * new state to it. This reduces the number of null checks in the context |
| * model (hopefully). |
| */ |
| Annotation buildNullAnnotation(JavaResourcePersistentMember parent); |
| |
| } |