jpa/plugins/org.eclipse.jpt.core/src/org/eclipse/jpt/core/utility/jdt/Attribute.java

/*******************************************************************************
 * Copyright (c) 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.utility.jdt;

import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.dom.ITypeBinding;

/**
 * Attributes are either represented by fields ('foo') or properties/method
 * pairs ('getFoo()'/'setFoo()').
 * 
 * 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.
 * 
 * This interface is not intended to be implemented by clients.
 */
public interface Attribute extends Member {

	/**
	 * Return the attribute's name, as opposed to the member's name
	 * (e.g. "getFoo()" returns "foo").
	 */
	// TODO rename to getName()?
	String getAttributeName();

	/**
	 * Return the type binding for the attribute's declared type,
	 * as opposed to its declaring type.
	 */
	ITypeBinding getTypeBinding(CompilationUnit astRoot);

	/**
	 * Return whether the attribute is a field.
	 */
	boolean isField();

	/**
	 * Return whether the attribute is a property/method pair.
	 */
	// TODO rename to isProperty()?
	boolean isMethod();

}