| /******************************************************************************* |
| * 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; |
| |
| /** |
| * This interface corresponds to the javax.persistence.IdClass 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 IdClassAnnotation extends JavaResourceNode |
| { |
| final String ANNOTATION_NAME = JPA.ID_CLASS; |
| |
| /** |
| * Corresponds to the value element of the IdClass annotation. |
| * Returns null if the value element does not exist in java. |
| * Returns the portion of the value preceding the .class. |
| * <p> |
| * @IdClass(value=Employee.class) |
| * </p> |
| * will return "Employee" |
| **/ |
| String getValue(); |
| |
| /** |
| * Corresponds to the value element of the IdClass annotation. |
| * Set to null to remove the value element. This will also remove the IdClass |
| * annotation itself. |
| */ |
| void setValue(String value); |
| String VALUE_PROPERTY = "value"; //$NON-NLS-1$ |
| |
| /** |
| * Returns the qualified value name as it is resolved in the AST |
| * <p> |
| * @IdClass(Employee.class) |
| * </p> |
| * will return "model.Employee" if there is an import for model.Employee |
| * @return |
| */ |
| String getFullyQualifiedClass(); |
| String FULLY_QUALIFIED_CLASS_PROPERTY = "fullyQualifiedClass"; //$NON-NLS-1$ |
| |
| /** |
| * Return the {@link TextRange} for the value element. If the value element |
| * does not exist return the {@link TextRange} for the IdClass annotation. |
| */ |
| TextRange getValueTextRange(CompilationUnit astRoot); |
| |
| } |