org.unix4j.unix.cd

Class CdArguments

java.lang.Object

org.unix4j.unix.cd.CdArguments

All Implemented Interfaces:

Arguments<CdArguments>

public final class CdArguments
extends Object
implements Arguments<CdArguments>

Arguments and options for the cd command.

Constructor Summary

Constructors

Constructor and Description
CdArguments() Constructor to use if no options are specified.

Method Summary

Modifier and Type	Method and Description
File	getFile() Returns the <file> operand value: the file to use as input; relative paths are not resolved (use the string path argument to enable relative path resolving based on the current working directory).
CdArguments	getForContext(ExecutionContext context) Returns an arguments object for the given execution context with resolved variables if necessary and possible.
String	getPath() Returns the <path> operand value (variables are NOT resolved): the directory to become the new current working directory; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
String	getPath(ExecutionContext context) Returns the <path> (variables are resolved): the directory to become the new current working directory; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
boolean	isFileSet() Returns true if the <file> operand has been set.
boolean	isPathSet() Returns true if the <path> operand has been set.
void	setFile(File file) Sets <file>: the file to use as input; relative paths are not resolved (use the string path argument to enable relative path resolving based on the current working directory).
void	setPath(String path) Sets <path>: the directory to become the new current working directory; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
String	toString() Returns a string representation of the command arguments and options.

Methods inherited from class java.lang.Object

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

Constructor Detail

CdArguments

public CdArguments()

Constructor to use if no options are specified.

Method Detail

getForContext

public CdArguments getForContext(ExecutionContext context)

Description copied from interface: Arguments

Returns an arguments object for the given execution context with resolved variables if necessary and possible. If variables are defined in this arguments instance, a new arguments instance is created with values instead of variables for those variables that are defined in the specified context object. If this arguments instance uses no variables, this arguments instance is simply returned.

If variables are present, they are resolved if such a variable is defined in the VariableContext returned by context.getVariableContext(). Values are converted if necessary with the ValueConverters returned by context.getValueConverterFor(Class).

Specified by:

getForContext in interface Arguments<CdArguments>

Parameters:

context - the execution context providing access to variables and converters

Returns:

an arguments object with resolved variables where possible

getFile

public File getFile()

Returns the <file> operand value: the file to use as input; relative paths are not resolved (use the string path argument to enable relative path resolving based on the current working directory).

Returns:

the <file> operand value (variables are not resolved)

Throws:

IllegalStateException - if this operand has never been set

isFileSet

public boolean isFileSet()

Returns true if the <file> operand has been set.

Note that this method returns true even if null was passed to the setFile(java.io.File) method.

Returns:

true if the setter for the <file> operand has been called at least once

setFile

public void setFile(File file)

Sets <file>: the file to use as input; relative paths are not resolved (use the string path argument to enable relative path resolving based on the current working directory).

Parameters:

file - the value for the <file> operand

getPath

public String getPath()

Returns the <path> operand value (variables are NOT resolved): the directory to become the new current working directory; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.

Returns:

the <path> operand value (variables are not resolved)

Throws:

IllegalStateException - if this operand has never been set

See Also:

getPath(ExecutionContext)

getPath

public String getPath(ExecutionContext context)

Returns the <path> (variables are resolved): the directory to become the new current working directory; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.

Parameters:

context - the execution context used to resolve variables

Returns:

the <path> operand value after resolving variables

Throws:

IllegalStateException - if this operand has never been set

See Also:

getPath()

isPathSet

public boolean isPathSet()

Returns true if the <path> operand has been set.

Note that this method returns true even if null was passed to the setPath(String) method.

Returns:

true if the setter for the <path> operand has been called at least once

setPath

public void setPath(String path)

Sets <path>: the directory to become the new current working directory; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.

Parameters:

path - the value for the <path> operand

toString

public String toString()

Description copied from interface: Arguments

Returns a string representation of the command arguments and options.

Specified by:

toString in interface Arguments<CdArguments>

Overrides:

toString in class Object

Returns:

a string representation of the command arguments and options, such as "-matchString myString -ignoreCase"