org.eclipse.jdt.core.eval.IGlobalVariable Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2000, 2008 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.eval;

/**
 * A global variable declared in an evaluation context.
 * IEvaluationContext.newVariable can be used to obtain an instance.
 * 
 *
 * @see IEvaluationContext#newVariable(String, String, String)
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IGlobalVariable {
/**
 * Returns the initializer of this global variable.
 * The syntax for an initializer corresponds to VariableInitializer (JLS2 8.3).
 *
 * @return the initializer expression, or null if this global does
 *    not have an initializer
 */
public String getInitializer();
/**
 * Returns the name of this global variable.
 *
 * @return the name of the global variable
 */
public String getName();
/**
 * Returns the fully qualified name of the type of this global
 * variable, or its simple representation if it is a primitive type
 * (int, boolean, etc.).
 * 
 * The syntax for a type name corresponds to Type in Field Declaration (JLS2 8.3).
 * 
 * @return the type name
 */
public String getTypeName();
}