org.unix4j.context

Interface ExecutionContext

All Known Implementing Classes:

DefaultExecutionContext, DerivedExecutionContext

public interface ExecutionContext

The execution context encapsulates all information relevant during the execution of a Command or chain of joined commands. It is passed to the execute(..) method providing access to the current directory, environment variables and other information useful for the commands during their execution.

Method Summary

Methods

Modifier and Type	Method and Description
ConverterRegistry	getConverterRegistry()
File	getCurrentDirectory() Returns the current directory, never null.
Map<String,String>	getEnv()
Locale	getLocale()
File	getRelativeToCurrentDirectory(File file) Returns the given file but relative to the current directory if the given file path is not absolute.
Properties	getSys()
File	getTempDirectory()
String	getUser() Returns the user name, usually defined by the "user.name" system property.
File	getUserHome() Returns the user home directory, usually defined by the "user.home" system property.
<V> ValueConverter<V>	getValueConverterFor(Class<V> type)
VariableContext	getVariableContext()

Method Detail

getCurrentDirectory

File getCurrentDirectory()

Returns the current directory, never null. If the current directory has not explicitly been changed, the file specified by the "user.dir" system property is returned.

Returns:

the current directory, the same as the "user.dir" system property it has not been set explicitly

See Also:

System.getProperties()

getRelativeToCurrentDirectory

File getRelativeToCurrentDirectory(File file)

Returns the given file but relative to the current directory if the given file path is not absolute. Most commands should resolve files through this method since the unix4j current directory and the Java current directory are not the same.

Parameters:

file - the file to return relative to the current directory if it denotes a relative path

Returns:

the given file relative to the execution context's current directory

getUser

String getUser()

Returns the user name, usually defined by the "user.name" system property.

Returns:

the user name, usually defined by the "user.name" system property

See Also:

System.getProperties()

getUserHome

File getUserHome()

Returns the user home directory, usually defined by the "user.home" system property.

Returns:

the user home directory, usually defined by the "user.home" system property

See Also:

System.getProperties()

getTempDirectory

File getTempDirectory()

getLocale

Locale getLocale()

getEnv

Map<String,String> getEnv()

getSys

Properties getSys()

getVariableContext

VariableContext getVariableContext()

getConverterRegistry

ConverterRegistry getConverterRegistry()

getValueConverterFor

<V> ValueConverter<V> getValueConverterFor(Class<V> type)