org.unix4j.context

Class DefaultExecutionContext

java.lang.Object

org.unix4j.context.DefaultExecutionContext

All Implemented Interfaces:

ExecutionContext

public class DefaultExecutionContext
extends java.lang.Object
implements ExecutionContext

Default execution context implementation with setters for some values and meaningful defaults for instance taken from system properties.

Field Summary

Fields

Modifier and Type	Field and Description
static ExecutionContextFactory	FACTORY Factory returning a new instance of DefaultExecutionContext using the default constructor.

Constructor Summary

Constructors

Constructor and Description
DefaultExecutionContext()
DefaultExecutionContext(java.io.File currentDirectory)

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FACTORY

public static final ExecutionContextFactory FACTORY

Factory returning a new instance of DefaultExecutionContext using the default constructor.

Constructor Detail

DefaultExecutionContext

public DefaultExecutionContext()

DefaultExecutionContext

public DefaultExecutionContext(java.io.File currentDirectory)

Method Detail

setCurrentDirectory

public void setCurrentDirectory(java.io.File currentDirectory)

setCurrentDirectory

public void setCurrentDirectory(java.lang.String currentDirectory)

getRelativeToCurrentDirectory

public java.io.File getRelativeToCurrentDirectory(java.io.File file)

Description copied from interface: ExecutionContext

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.

Specified by:

getRelativeToCurrentDirectory in interface ExecutionContext

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

getCurrentDirectory

public java.io.File getCurrentDirectory()

Description copied from interface: ExecutionContext

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.

Specified by:

getCurrentDirectory in interface ExecutionContext

Returns:

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

See Also:

System.getProperties()

getUser

public java.lang.String getUser()

Description copied from interface: ExecutionContext

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

Specified by:

getUser in interface ExecutionContext

Returns:

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

See Also:

System.getProperties()

getUserHome

public java.io.File getUserHome()

Description copied from interface: ExecutionContext

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

Specified by:

getUserHome in interface ExecutionContext

Returns:

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

See Also:

System.getProperties()

getTempDirectory

public java.io.File getTempDirectory()

Specified by:

getTempDirectory in interface ExecutionContext

setLocale

public void setLocale(java.util.Locale locale)

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface ExecutionContext

getEnv

public java.util.Map<java.lang.String,java.lang.String> getEnv()

Specified by:

getEnv in interface ExecutionContext

getSys

public java.util.Properties getSys()

Specified by:

getSys in interface ExecutionContext

getVariableContext

public VariableContext getVariableContext()

Specified by:

getVariableContext in interface ExecutionContext

getConverterRegistry

public ConverterRegistry getConverterRegistry()

Specified by:

getConverterRegistry in interface ExecutionContext

getValueConverterFor

public <V> ValueConverter<V> getValueConverterFor(java.lang.Class<V> type)

Specified by:

getValueConverterFor in interface ExecutionContext