| /******************************************************************************* |
| * 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.dom.CompilationUnit; |
| import org.eclipse.jpt.core.utility.TextRange; |
| |
| /** |
| * Common protocol among |
| * javax.persistence.Column |
| * javax.persistence.JoinColumn |
| * |
| * 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 BaseColumnAnnotation |
| extends NamedColumnAnnotation |
| { |
| /** |
| * Corresponds to the 'unique' element of the *Column annotation. |
| * Return null if the element does not exist in Java. |
| */ |
| Boolean getUnique(); |
| String UNIQUE_PROPERTY = "unique"; //$NON-NLS-1$ |
| |
| /** |
| * Corresponds to the 'unique' element of the *Column annotation. |
| * Set to null to remove the element. |
| */ |
| void setUnique(Boolean unique); |
| |
| /** |
| * Return the {@link TextRange} for the 'unique' element. If the element |
| * does not exist return the {@link TextRange} for the *Column annotation. |
| */ |
| TextRange getUniqueTextRange(CompilationUnit astRoot); |
| |
| |
| /** |
| * Corresponds to the 'nullable' element of the *Column annotation. |
| * Return null if the element does not exist in Java. |
| */ |
| Boolean getNullable(); |
| String NULLABLE_PROPERTY = "nullable"; //$NON-NLS-1$ |
| |
| /** |
| * Corresponds to the 'nullable' element of the *Column annotation. |
| * Set to null to remove the element. |
| */ |
| void setNullable(Boolean nullable); |
| |
| /** |
| * Return the {@link TextRange} for the 'nullable' element. If the element |
| * does not exist return the {@link TextRange} for the *Column annotation. |
| */ |
| TextRange getNullableTextRange(CompilationUnit astRoot); |
| |
| |
| /** |
| * Corresponds to the 'insertable' element of the *Column annotation. |
| * Return null if the element does not exist in Java. |
| */ |
| Boolean getInsertable(); |
| String INSERTABLE_PROPERTY = "insertable"; //$NON-NLS-1$ |
| |
| /** |
| * Corresponds to the 'insertable' element of the *Column annotation. |
| * Set to null to remove the element. |
| */ |
| void setInsertable(Boolean insertable); |
| |
| /** |
| * Return the {@link TextRange} for the 'insertable' element. If the element |
| * does not exist return the {@link TextRange} for the *Column annotation. |
| */ |
| TextRange getInsertableTextRange(CompilationUnit astRoot); |
| |
| |
| /** |
| * Corresponds to the 'updatable' element of the *Column annotation. |
| * Return null if the element does not exist in Java. |
| */ |
| Boolean getUpdatable(); |
| String UPDATABLE_PROPERTY = "updatable"; //$NON-NLS-1$ |
| |
| /** |
| * Corresponds to the 'updatable' element of the *Column annotation. |
| * Set to null to remove the element. |
| */ |
| void setUpdatable(Boolean updatable); |
| |
| /** |
| * Return the {@link TextRange} for the 'updatable' element. If the element |
| * does not exist return the {@link TextRange} for the *Column annotation. |
| */ |
| TextRange getUpdatableTextRange(CompilationUnit astRoot); |
| |
| |
| /** |
| * Corresponds to the 'table' element of the *Column annotation. |
| * Return null if the element does not exist in Java. |
| */ |
| String getTable(); |
| String TABLE_PROPERTY = "table"; //$NON-NLS-1$ |
| |
| /** |
| * Corresponds to the 'table' element of the *Column annotation. |
| * Set to null to remove the element. |
| */ |
| void setTable(String table); |
| |
| /** |
| * Return the {@link TextRange} for the 'table' element. If the element |
| * does not exist return the {@link TextRange} for the *Column annotation. |
| */ |
| TextRange getTableTextRange(CompilationUnit astRoot); |
| |
| /** |
| * Return whether the specified position touches the 'table' element. |
| * Return false if the element does not exist. |
| */ |
| boolean tableTouches(int pos, CompilationUnit astRoot); |
| |
| } |