org.unix4j.unix.from

Class FromArguments

java.lang.Object

org.unix4j.unix.from.FromArguments

All Implemented Interfaces:

Arguments<FromArguments>

public final class FromArguments
extends Object
implements Arguments<FromArguments>

Arguments and options for the from command.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Class<?>	getBase() Returns the <base> operand value: base class for subsequent resource operand if relative paths are used.
FromArguments	getForContext(ExecutionContext context) Returns an arguments object for the given execution context with resolved variables if necessary and possible.
Input	getInput() Returns the <input> operand value: the input object to read from
String	getPath() Returns the <path> operand value (variables are NOT resolved): the file to use as input; 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 file to use as input; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
String	getResource() Returns the <resource> operand value (variables are NOT resolved): a path to the file to redirect to the next command.
String	getResource(ExecutionContext context) Returns the <resource> (variables are resolved): a path to the file to redirect to the next command.
boolean	isBaseSet() Returns true if the <base> operand has been set.
boolean	isInputSet() Returns true if the <input> operand has been set.
boolean	isPathSet() Returns true if the <path> operand has been set.
boolean	isResourceSet() Returns true if the <resource> operand has been set.
void	setBase(Class<?> base) Sets <base>: base class for subsequent resource operand if relative paths are used.
void	setInput(Input input) Sets <input>: the input object to read from
void	setPath(String path) Sets <path>: the file to use as input; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
void	setResource(String resource) Sets <resource>: a path to the file to redirect to the next command.
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

FromArguments

public FromArguments()

Constructor to use if no options are specified.

Method Detail

getForContext

public FromArguments 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<FromArguments>

Parameters:

context - the execution context providing access to variables and converters

Returns:

an arguments object with resolved variables where possible

getPath

public String getPath()

Returns the <path> operand value (variables are NOT resolved): the file to use as input; 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 file to use as input; 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 file to use as input; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.

Parameters:

path - the value for the <path> operand

getBase

public Class<?> getBase()

Returns the <base> operand value: base class for subsequent resource operand if relative paths are used.

Returns:

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

Throws:

IllegalStateException - if this operand has never been set

isBaseSet

public boolean isBaseSet()

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

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

Returns:

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

setBase

public void setBase(Class<?> base)

Sets <base>: base class for subsequent resource operand if relative paths are used.

Parameters:

base - the value for the <base> operand

getResource

public String getResource()

Returns the <resource> operand value (variables are NOT resolved): a path to the file to redirect to the next command. The resource needs to be on the classpath. If the file is in the root directory, the filename should be prefixed with a forward slash. e.g.: "/test-file.txt".

If the file is in a package, then the package should be specified prefixed with a forward slash, and with each dot "." replaced with a forward slash. e.g.: "/org/company/mypackage/test-file.txt". A base class operand can be provided for relative paths; see Class.getResourceAsStream(String) for details about resource loading.

Returns:

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

Throws:

IllegalStateException - if this operand has never been set

See Also:

getResource(ExecutionContext)

getResource

public String getResource(ExecutionContext context)

Returns the <resource> (variables are resolved): a path to the file to redirect to the next command. The resource needs to be on the classpath. If the file is in the root directory, the filename should be prefixed with a forward slash. e.g.: "/test-file.txt".

If the file is in a package, then the package should be specified prefixed with a forward slash, and with each dot "." replaced with a forward slash. e.g.: "/org/company/mypackage/test-file.txt". A base class operand can be provided for relative paths; see Class.getResourceAsStream(String) for details about resource loading.

Parameters:

context - the execution context used to resolve variables

Returns:

the <resource> operand value after resolving variables

Throws:

IllegalStateException - if this operand has never been set

See Also:

getResource()

isResourceSet

public boolean isResourceSet()

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

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

Returns:

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

setResource

public void setResource(String resource)

Sets <resource>: a path to the file to redirect to the next command. The resource needs to be on the classpath. If the file is in the root directory, the filename should be prefixed with a forward slash. e.g.: "/test-file.txt".

If the file is in a package, then the package should be specified prefixed with a forward slash, and with each dot "." replaced with a forward slash. e.g.: "/org/company/mypackage/test-file.txt". A base class operand can be provided for relative paths; see Class.getResourceAsStream(String) for details about resource loading.

Parameters:

resource - the value for the <resource> operand

getInput

public Input getInput()

Returns the <input> operand value: the input object to read from

Returns:

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

Throws:

IllegalStateException - if this operand has never been set

isInputSet

public boolean isInputSet()

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

Note that this method returns true even if null was passed to the setInput(org.unix4j.io.Input) method.

Returns:

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

setInput

public void setInput(Input input)

Sets <input>: the input object to read from

Parameters:

input - the value for the <input> 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<FromArguments>

Overrides:

toString in class Object

Returns:

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