/*******************************************************************************
* Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package net.sourceforge.phpdt.core;
/**
* Represents a local variable declared in a method or an initializer.
* ILocalVariable
are pseudo-elements created as the result of a ICodeAssist.codeSelect(...)
* operation. They are not part of the Java model (exists()
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 IMethod
* or an IInitializer
.
*
* 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. *
* This interface is not intended to be implemented by clients. *
* @since 3.0 */ public interface ILocalVariable extends IJavaElement, ISourceReference { /** * 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. ** 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. *
* * @return the type signature of this local variable. * @see Signature */ String getTypeSignature(); }