]> gerrit.simantics Code Review - simantics/platform.git/blob - bundles/org.simantics.scl.expressions/src/org/simantics/scl/expressions/EnvironmentDescription.java
Migrated source code from Simantics SVN
[simantics/platform.git] / bundles / org.simantics.scl.expressions / src / org / simantics / scl / expressions / EnvironmentDescription.java
1 package org.simantics.scl.expressions;\r
2 \r
3 /**\r
4  * Describes an environment for evaluating expressions.\r
5  * The description includes the names and types of the\r
6  * environment variables, but not necessarily the values.\r
7  * The values are obtained using the ContextualValues\r
8  * given by successfully resolved variables. \r
9  * @author Hannu Niemistö\r
10  * @param <Context>\r
11  */\r
12 public interface EnvironmentDescription<Context> {\r
13     /**\r
14      * Tries to resolve an environment variable\r
15      * with a given name. Returns <code>null</code>\r
16      * if there is no such variable. If variable is\r
17      * found, returns ContextualValue that can be\r
18      * used to obtain the value of the environment \r
19      * variable with a suitable context.\r
20      * @param name\r
21      * @return\r
22      */\r
23     ContextualValue<Context> resolve(String name);\r
24 }\r