| /******************************************************************************* |
| * Copyright (c) 2000, 2010 IBM Corporation and others. |
| * 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: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.jdt.core; |
| |
| /** |
| * Represents a local variable declared in a method or an initializer. |
| * <code>ILocalVariable</code> are pseudo-elements created as the result of a <code>ICodeAssist.codeSelect(...)</code> |
| * operation. They are not part of the Java model (<code>exists()</code> returns whether the parent exists rather than |
| * whether the local variable exists in the parent) and they are not included in the children of an <code>IMethod</code> |
| * or an <code>IInitializer</code>. |
| * <p> |
| * In particular such a pseudo-element should not be used as a handle. For example its name range won't be updated |
| * if the underlying source changes. |
| * </p> |
| * |
| * @since 3.0 |
| * @noimplement This interface is not intended to be implemented by clients. |
| */ |
| public interface ILocalVariable extends IJavaElement, ISourceReference, IAnnotatable { |
| |
| /** |
| * Returns the name of this local variable. |
| * |
| * @return the name of this local variable. |
| */ |
| String getElementName(); |
| |
| /** |
| * Returns the source range of this local variable's name. |
| * |
| * @return the source range of this local variable's name |
| */ |
| ISourceRange getNameRange(); |
| |
| /** |
| * Returns the type signature of this local variable. |
| * <p> |
| * The type signature may be either unresolved (for source types) |
| * or resolved (for binary types), and either basic (for basic types) |
| * or rich (for parameterized types). See {@link Signature} for details. |
| * </p> |
| * |
| * @return the type signature of this local variable. |
| * @see Signature |
| */ |
| String getTypeSignature(); |
| |
| /** |
| * Returns <code>true</code> if this local variable is a method parameter, <code>false</code> otherwise. |
| * |
| * @return <code>true</code> if this local variable is a method parameter, <code>false</code> otherwise |
| * @since 3.7 |
| */ |
| boolean isParameter(); |
| |
| /** |
| * Returns the modifier flags for this local variable. The flags can be examined using class |
| * {@link Flags}. |
| * |
| * <p>Note that only flags as indicated in the source are returned.</p> |
| * |
| * @return the modifier flags for this local variable |
| * @see Flags |
| * @since 3.7 |
| */ |
| int getFlags(); |
| |
| /** |
| * Returns the declaring member of this local variable. |
| * <p> |
| * This is a handle-only method. |
| * </p> |
| * |
| * @return the declaring member of this local variable |
| * @since 3.7 |
| */ |
| IMember getDeclaringMember(); |
| |
| /** |
| * Returns the Java type root in which this local variable is declared. |
| * <p> |
| * This is a handle-only method. |
| * </p> |
| * |
| * @return the Java type root in which this local variable is declared |
| * @since 3.7 |
| */ |
| ITypeRoot getTypeRoot(); |
| } |