KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jdt > core > eval > IGlobalVariable


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.jdt.core.eval;
12
13 /**
14  * A global variable declared in an evaluation context.
15  * <p>
16  * This interface is not intended to be implemented by clients.
17  * <code>IEvaluationContext.newVariable</code> can be used to obtain an instance.
18  * </p>
19  *
20  * @see IEvaluationContext#newVariable(String, String, String)
21  */
22 public interface IGlobalVariable {
23 /**
24  * Returns the initializer of this global variable.
25  * The syntax for an initializer corresponds to VariableInitializer (JLS2 8.3).
26  *
27  * @return the initializer expression, or <code>null</code> if this global does
28  * not have an initializer
29  */
30 public String JavaDoc getInitializer();
31 /**
32  * Returns the name of this global variable.
33  *
34  * @return the name of the global variable
35  */
36 public String JavaDoc getName();
37 /**
38  * Returns the fully qualified name of the type of this global
39  * variable, or its simple representation if it is a primitive type
40  * (<code>int</code>, <code>boolean</code>, etc.).
41  * <p>
42  * The syntax for a type name corresponds to Type in Field Declaration (JLS2 8.3).
43  * </p>
44  * @return the type name
45  */
46 public String JavaDoc getTypeName();
47 }
48
Popular Tags