org.unix4j.variable

Enum ExecutionContextVariableResolver.Variable

java.lang.Object

java.lang.Enum<ExecutionContextVariableResolver.Variable>

org.unix4j.variable.ExecutionContextVariableResolver.Variable

All Implemented Interfaces:

Serializable, Comparable<ExecutionContextVariableResolver.Variable>

Enclosing class:

ExecutionContextVariableResolver

public static enum ExecutionContextVariableResolver.Variable
extends Enum<ExecutionContextVariableResolver.Variable>

Variable name constants for ExecutionContext values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CurrentDirectory Variable $pwd to access ExecutionContext.getCurrentDirectory().
Locale Variable $locale to access ExecutionContext.getLocale().
TempDirectory Variable $temp to access ExecutionContext.getTempDirectory().
User Variable $whoami to access ExecutionContext.getUser() .
UserHome Variable $home to access ExecutionContext.getUserHome().

Method Summary

Modifier and Type	Method and Description
static ExecutionContextVariableResolver.Variable	getByVariableName(String variableName)
String	getUnixName()
abstract Object	getValue(ExecutionContext executionContext)
static ExecutionContextVariableResolver.Variable	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExecutionContextVariableResolver.Variable[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CurrentDirectory

public static final ExecutionContextVariableResolver.Variable CurrentDirectory

Variable $pwd to access ExecutionContext.getCurrentDirectory().

User

public static final ExecutionContextVariableResolver.Variable User

Variable $whoami to access ExecutionContext.getUser() .

UserHome

public static final ExecutionContextVariableResolver.Variable UserHome

Variable $home to access ExecutionContext.getUserHome().

TempDirectory

public static final ExecutionContextVariableResolver.Variable TempDirectory

Variable $temp to access ExecutionContext.getTempDirectory().

Locale

public static final ExecutionContextVariableResolver.Variable Locale

Variable $locale to access ExecutionContext.getLocale().

Method Detail

values

public static ExecutionContextVariableResolver.Variable[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ExecutionContextVariableResolver.Variable c : ExecutionContextVariableResolver.Variable.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExecutionContextVariableResolver.Variable valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getUnixName

public String getUnixName()

getByVariableName

public static ExecutionContextVariableResolver.Variable getByVariableName(String variableName)

getValue

public abstract Object getValue(ExecutionContext executionContext)