org.unix4j.unix.echo

Class EchoArguments

java.lang.Object

org.unix4j.unix.echo.EchoArguments

All Implemented Interfaces:

Arguments<EchoArguments>

public final class EchoArguments
extends Object
implements Arguments<EchoArguments>

Arguments and options for the echo command.

Constructor Summary

Constructors

Constructor and Description
EchoArguments() Constructor to use if no options are specified.
EchoArguments(EchoOptions options) Constructor with option set containing the selected command options.
EchoArguments(String... args) Constructor string arguments encoding options and arguments, possibly also containing variable expressions.

Method Summary

Modifier and Type	Method and Description
String[]	getArgs() Returns the <args> operand value: String arguments defining the options for the command and the strings to be written to the output.
EchoArguments	getForContext(ExecutionContext context) Returns an arguments object for the given execution context with resolved variables if necessary and possible.
EchoOptions	getOptions() Returns the options set containing the selected command options.
String	getString() Returns the <string> operand value (variables are NOT resolved): A string to be written to standard output.
String	getString(ExecutionContext context) Returns the <string> (variables are resolved): A string to be written to standard output.
String[]	getStrings() Returns the <strings> operand value: Strings to be written to standard output, separated by single blank characters.
boolean	isArgsSet() Returns true if the <args> operand has been set.
boolean	isNoNewline() Returns true if the --noNewline option is set.
boolean	isStringSet() Returns true if the <string> operand has been set.
boolean	isStringsSet() Returns true if the <strings> operand has been set.
void	setString(String string) Sets <string>: A string to be written to standard output.
void	setStrings(String... strings) Sets <strings>: Strings to be written to standard output, separated by single blank characters.
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

EchoArguments

public EchoArguments()

Constructor to use if no options are specified.

EchoArguments

public EchoArguments(EchoOptions options)

Constructor with option set containing the selected command options.

Parameters:

options - the selected options

Throws:

NullPointerException - if the argument is null

EchoArguments

public EchoArguments(String... args)

Constructor string arguments encoding options and arguments, possibly also containing variable expressions.

Parameters:

args - string arguments for the command

Throws:

NullPointerException - if args is null

Method Detail

getOptions

public EchoOptions getOptions()

Returns the options set containing the selected command options. Returns an empty options set if no option has been selected.

Returns:

set with the selected options

getForContext

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

Parameters:

context - the execution context providing access to variables and converters

Returns:

an arguments object with resolved variables where possible

getString

public String getString()

Returns the <string> operand value (variables are NOT resolved): A string to be written to standard output.

Returns:

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

Throws:

IllegalStateException - if this operand has never been set

See Also:

getString(ExecutionContext)

getString

public String getString(ExecutionContext context)

Returns the <string> (variables are resolved): A string to be written to standard output.

Parameters:

context - the execution context used to resolve variables

Returns:

the <string> operand value after resolving variables

Throws:

IllegalStateException - if this operand has never been set

See Also:

getString()

isStringSet

public boolean isStringSet()

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

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

Returns:

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

setString

public void setString(String string)

Sets <string>: A string to be written to standard output.

Parameters:

string - the value for the <string> operand

getStrings

public String[] getStrings()

Returns the <strings> operand value: Strings to be written to standard output, separated by single blank characters.

Returns:

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

Throws:

IllegalStateException - if this operand has never been set

isStringsSet

public boolean isStringsSet()

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

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

Returns:

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

setStrings

public void setStrings(String... strings)

Sets <strings>: Strings to be written to standard output, separated by single blank characters.

Parameters:

strings - the value for the <strings> operand

getArgs

public String[] getArgs()

Returns the <args> operand value: String arguments defining the options for the command and the strings to be written to the output. Options can be specified by acronym (with a leading dash "-") or by long name (with two leading dashes "--").

Returns:

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

Throws:

IllegalStateException - if this operand has never been set

isArgsSet

public boolean isArgsSet()

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

Returns:

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

isNoNewline

public boolean isNoNewline()

Returns true if the --noNewline option is set. The option is also known as -n option.

Description: Do not print the trailing newline character(s).

Returns:

true if the --noNewline or -n option is set

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<EchoArguments>

Overrides:

toString in class Object

Returns:

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