org.unix4j.unix.find

Class FindArguments

java.lang.Object

org.unix4j.unix.find.FindArguments

All Implemented Interfaces:

Arguments<FindArguments>

public final class FindArguments
extends Object
implements Arguments<FindArguments>

Arguments and options for the find command.

Constructor Summary

Constructors

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

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.
FindArguments	getForContext(ExecutionContext context) Returns an arguments object for the given execution context with resolved variables if necessary and possible.
String	getName() Returns the <name> operand value (variables are NOT resolved): Name pattern to match the file name after removing the path with the leading directories; wildcards * and ? are supported, or full regular expressions if either of the options -regex (-r) or -iregex (-i) is specified.
String	getName(ExecutionContext context) Returns the <name> (variables are resolved): Name pattern to match the file name after removing the path with the leading directories; wildcards * and ? are supported, or full regular expressions if either of the options -regex (-r) or -iregex (-i) is specified.
FindOptions	getOptions() Returns the options set containing the selected command options.
String	getPath() Returns the <path> operand value (variables are NOT resolved): Starting point for the search in the directory hierarchy; 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): Starting point for the search in the directory hierarchy; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
long	getSize() Returns the <size> operand value: Consider only files using at least size bytes if size is positive, or at most abs(size) bytes if size is zero or negative.
Date	getTime() Returns the <time> operand value: Consider only files that have been created, modified or accessed before or after the specified time operand; consider the -time... options for details of the comparison.
boolean	isArgsSet() Returns true if the <args> operand has been set.
boolean	isIgnoreCase() Returns true if the --ignoreCase option is set.
boolean	isNameSet() Returns true if the <name> operand has been set.
boolean	isPathSet() Returns true if the <path> operand has been set.
boolean	isPrint0() Returns true if the --print0 option is set.
boolean	isRegex() Returns true if the --regex option is set.
boolean	isSizeSet() Returns true if the <size> operand has been set.
boolean	isTimeAccess() Returns true if the --timeAccess option is set.
boolean	isTimeCreate() Returns true if the --timeCreate option is set.
boolean	isTimeModified() Returns true if the --timeModified option is set.
boolean	isTimeNewer() Returns true if the --timeNewer option is set.
boolean	isTimeOlder() Returns true if the --timeOlder option is set.
boolean	isTimeSet() Returns true if the <time> operand has been set.
boolean	isTypeDirectory() Returns true if the --typeDirectory option is set.
boolean	isTypeFile() Returns true if the --typeFile option is set.
boolean	isTypeOther() Returns true if the --typeOther option is set.
boolean	isTypeSymlink() Returns true if the --typeSymlink option is set.
void	setName(String name) Sets <name>: Name pattern to match the file name after removing the path with the leading directories; wildcards * and ? are supported, or full regular expressions if either of the options -regex (-r) or -iregex (-i) is specified.
void	setPath(String path) Sets <path>: Starting point for the search in the directory hierarchy; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.
void	setSize(long size) Sets <size>: Consider only files using at least size bytes if size is positive, or at most abs(size) bytes if size is zero or negative.
void	setTime(Date time) Sets <time>: Consider only files that have been created, modified or accessed before or after the specified time operand; consider the -time... options for details of the comparison.
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

FindArguments

public FindArguments()

Constructor to use if no options are specified.

FindArguments

public FindArguments(FindOptions options)

Constructor with option set containing the selected command options.

Parameters:

options - the selected options

Throws:

NullPointerException - if the argument is null

FindArguments

public FindArguments(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 FindOptions 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 FindArguments 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<FindArguments>

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): Starting point for the search in the directory hierarchy; 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): Starting point for the search in the directory hierarchy; 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>: Starting point for the search in the directory hierarchy; wildcards * and ? are supported; relative paths are resolved on the basis of the current working directory.

Parameters:

path - the value for the <path> operand

getName

public String getName()

Returns the <name> operand value (variables are NOT resolved): Name pattern to match the file name after removing the path with the leading directories; wildcards * and ? are supported, or full regular expressions if either of the options -regex (-r) or -iregex (-i) is specified.

Returns:

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

Throws:

IllegalStateException - if this operand has never been set

See Also:

getName(ExecutionContext)

getName

public String getName(ExecutionContext context)

Returns the <name> (variables are resolved): Name pattern to match the file name after removing the path with the leading directories; wildcards * and ? are supported, or full regular expressions if either of the options -regex (-r) or -iregex (-i) is specified.

Parameters:

context - the execution context used to resolve variables

Returns:

the <name> operand value after resolving variables

Throws:

IllegalStateException - if this operand has never been set

See Also:

getName()

isNameSet

public boolean isNameSet()

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

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

Returns:

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

setName

public void setName(String name)

Sets <name>: Name pattern to match the file name after removing the path with the leading directories; wildcards * and ? are supported, or full regular expressions if either of the options -regex (-r) or -iregex (-i) is specified.

Parameters:

name - the value for the <name> operand

getSize

public long getSize()

Returns the <size> operand value: Consider only files using at least size bytes if size is positive, or at most abs(size) bytes if size is zero or negative.

Returns:

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

Throws:

IllegalStateException - if this operand has never been set

isSizeSet

public boolean isSizeSet()

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

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

Returns:

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

setSize

public void setSize(long size)

Sets <size>: Consider only files using at least size bytes if size is positive, or at most abs(size) bytes if size is zero or negative.

Parameters:

size - the value for the <size> operand

getTime

public Date getTime()

Returns the <time> operand value: Consider only files that have been created, modified or accessed before or after the specified time operand; consider the -time... options for details of the comparison.

Returns:

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

Throws:

IllegalStateException - if this operand has never been set

isTimeSet

public boolean isTimeSet()

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

Note that this method returns true even if null was passed to the setTime(java.util.Date) method.

Returns:

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

setTime

public void setTime(Date time)

Sets <time>: Consider only files that have been created, modified or accessed before or after the specified time operand; consider the -time... options for details of the comparison.

Parameters:

time - the value for the <time> 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 (e.g. "--name" for subsequent path operand values).

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

isTypeDirectory

public boolean isTypeDirectory()

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

Description: Consider only directories

Returns:

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

isTypeFile

public boolean isTypeFile()

Returns true if the --typeFile option is set. The option is also known as -f option.

Description: Consider only regular files

Returns:

true if the --typeFile or -f option is set

isTypeSymlink

public boolean isTypeSymlink()

Returns true if the --typeSymlink option is set. The option is also known as -l option.

Description: Consider only symbolic links

Returns:

true if the --typeSymlink or -l option is set

isTypeOther

public boolean isTypeOther()

Returns true if the --typeOther option is set. The option is also known as -x option.

Description: Consider only files that are neither of directory (d), regular file (f) or symlink (l).

Returns:

true if the --typeOther or -x option is set

isRegex

public boolean isRegex()

Returns true if the --regex option is set. The option is also known as -r option.

Description: Use full regular expression syntax for the patterns specified by the name operand

(This option is ignored if no name operand is specified).

Returns:

true if the --regex or -r option is set

isIgnoreCase

public boolean isIgnoreCase()

Returns true if the --ignoreCase option is set. The option is also known as -i option.

Description: Use case insensitive matching when applying the file name pattern specified by the name operand

(This option is ignored if no name operand is specified).

Returns:

true if the --ignoreCase or -i option is set

isTimeNewer

public boolean isTimeNewer()

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

Description: Consider only files that have been created, modified or accessed after or at the time specified by the time operand (the default)

(This option is ignored if no time operand is specified).

Returns:

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

isTimeOlder

public boolean isTimeOlder()

Returns true if the --timeOlder option is set. The option is also known as -o option.

Description: Consider only files that have been created, modified or accessed before or at the time specified by the time operand

(This option is ignored if no time operand is specified).

Returns:

true if the --timeOlder or -o option is set

isTimeCreate

public boolean isTimeCreate()

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

Description: The time operand refers to the creation time of the file

(This option is ignored if no time operand is specified).

Returns:

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

isTimeAccess

public boolean isTimeAccess()

Returns true if the --timeAccess option is set. The option is also known as -a option.

Description: The time operand refers to the last access time of the file

(This option is ignored if no time operand is specified).

Returns:

true if the --timeAccess or -a option is set

isTimeModified

public boolean isTimeModified()

Returns true if the --timeModified option is set. The option is also known as -m option.

Description: The time operand refers to the last modification time of the file (the default)

(This option is ignored if no time operand is specified).

Returns:

true if the --timeModified or -m option is set

isPrint0

public boolean isPrint0()

Returns true if the --print0 option is set. The option is also known as -z option.

Description: Print the full file name on the standard output, followed by a null character (instead of the newline character used by default). This allows file names that contain newlines or other types of white space to be correctly interpreted by programs that process the find output. This option corresponds to the --delimiter0 option of xargs.

Returns:

true if the --print0 or -z 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<FindArguments>

Overrides:

toString in class Object

Returns:

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