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