org.unix4j.unix.uniq

Class UniqArguments

java.lang.Object

org.unix4j.unix.uniq.UniqArguments

All Implemented Interfaces:

Arguments<UniqArguments>

public final class UniqArguments
extends Object
implements Arguments<UniqArguments>

Arguments and options for the uniq command.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getArgs() Returns the <args> operand value: String arguments defining the options and operands for the command.
File	getFile() Returns the <file> operand value: The files or directories used as starting point for the listing; relative paths are not resolved (use the string path argument to enable relative path resolving based on the current working directory).
UniqArguments	getForContext(ExecutionContext context) Returns an arguments object for the given execution context with resolved variables if necessary and possible.
UniqOptions	getOptions() Returns the options set containing the selected command options.
String	getPath() Returns the <path> operand value (variables are NOT resolved): The files or directories used as starting point for the listing; 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 files or directories used as starting point for the listing; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
boolean	isArgsSet() Returns true if the <args> operand has been set.
boolean	isCount() Returns true if the --count option is set.
boolean	isDuplicatedOnly() Returns true if the --duplicatedOnly option is set.
boolean	isFileSet() Returns true if the <file> operand has been set.
boolean	isGlobal() Returns true if the --global option is set.
boolean	isPathSet() Returns true if the <path> operand has been set.
boolean	isUniqueOnly() Returns true if the --uniqueOnly option is set.
void	setFile(File file) Sets <file>: The files or directories used as starting point for the listing; 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 files or directories used as starting point for the listing; 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

UniqArguments

public UniqArguments()

Constructor to use if no options are specified.

UniqArguments

public UniqArguments(UniqOptions options)

Constructor with option set containing the selected command options.

Parameters:

options - the selected options

Throws:

NullPointerException - if the argument is null

UniqArguments

public UniqArguments(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 UniqOptions 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 UniqArguments 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<UniqArguments>

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 files or directories used as starting point for the listing; 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 files or directories used as starting point for the listing; 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 files or directories used as starting point for the listing; 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 files or directories used as starting point for the listing; 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 files or directories used as starting point for the listing; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.

Parameters:

path - the value for the <path> operand

getArgs

public String[] getArgs()

Returns the <args> operand value: String arguments defining the options and operands for the command. Options can be specified by acronym (with a leading dash "-") or by long name (with two leading dashes "--"). Operands other than the default "--path" operand have to be prefixed with the operand name.

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

isCount

public boolean isCount()

Returns true if the --count option is set. The option is also known as -c option.

Description: Precedes each output line with a count of the number of times the line occurred in the input.

Returns:

true if the --count or -c option is set

isDuplicatedOnly

public boolean isDuplicatedOnly()

Returns true if the --duplicatedOnly option is set. The option is also known as -d option.

Description: Suppresses the writing of lines that are not repeated in the input.

Returns:

true if the --duplicatedOnly or -d option is set

isUniqueOnly

public boolean isUniqueOnly()

Returns true if the --uniqueOnly option is set. The option is also known as -u option.

Description: Suppresses the writing of lines that are repeated in the input.

Returns:

true if the --uniqueOnly or -u option is set

isGlobal

public boolean isGlobal()

Returns true if the --global option is set. The option is also known as -g option.

Description: Suppresses repeated lines globally, that is, if lines are non-adjacent. This option guarantees unique output lines even if the input lines are not sorted.

Returns:

true if the --global or -g 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<UniqArguments>

Overrides:

toString in class Object

Returns:

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