Package com.igormaznitsa.jcp.context
Class EnvironmentVariableProcessor
- java.lang.Object
-
- com.igormaznitsa.jcp.context.EnvironmentVariableProcessor
-
- All Implemented Interfaces:
SpecialVariableProcessor
public class EnvironmentVariableProcessor extends java.lang.Object implements SpecialVariableProcessor
The class allows to get access to environment variables from preprocessor expression, the variables have the "env." prefix and all them are String type All environment variables are allowed for reading and disallowing for writing
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Map<java.lang.String,Value>
environmentVars
private static java.lang.String
PREFIX
-
Constructor Summary
Constructors Constructor Description EnvironmentVariableProcessor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Value
getVariable(java.lang.String varName, PreprocessorContext context)
Get the value for the variablejava.lang.String[]
getVariableNames()
Get all variable names allowed by the processor as an array, all names must be in lower casevoid
setVariable(java.lang.String varName, Value value, PreprocessorContext context)
Set a value to the variable
-
-
-
Field Detail
-
PREFIX
private static final java.lang.String PREFIX
- See Also:
- Constant Field Values
-
environmentVars
private final java.util.Map<java.lang.String,Value> environmentVars
-
-
Method Detail
-
getVariableNames
@MustNotContainNull public java.lang.String[] getVariableNames()
Description copied from interface:SpecialVariableProcessor
Get all variable names allowed by the processor as an array, all names must be in lower case- Specified by:
getVariableNames
in interfaceSpecialVariableProcessor
- Returns:
- allowed variable names as a String array
-
getVariable
public Value getVariable(java.lang.String varName, PreprocessorContext context)
Description copied from interface:SpecialVariableProcessor
Get the value for the variable- Specified by:
getVariable
in interfaceSpecialVariableProcessor
- Parameters:
varName
- the variable name, must not be nullcontext
- the preprocessor context, it can be null- Returns:
- the value, it must not return null because it will notified preprocessor that it supports the variable
-
setVariable
public void setVariable(java.lang.String varName, Value value, PreprocessorContext context)
Description copied from interface:SpecialVariableProcessor
Set a value to the variable- Specified by:
setVariable
in interfaceSpecialVariableProcessor
- Parameters:
varName
- the variable name, must not be nullvalue
- the value to be set to the variable, must not be nullcontext
- the preprocessor context, it can be null
-
-