org.unix4j.unix.find

Enum FindOption

java.lang.Object

java.lang.Enum<FindOption>

org.unix4j.unix.find.FindOption

All Implemented Interfaces:

Serializable, Comparable<FindOption>, Iterable<FindOption>, Option, OptionSet<FindOption>, FindOptions

public enum FindOption
extends Enum<FindOption>
implements Option, FindOptions

Options for the find command.

For most applications, it may be more convenient to use Find.Options instead of the option constants defined here.

	-d		--typeDirectory		Consider only directories
	-f		--typeFile		Consider only regular files
	-l		--typeSymlink		Consider only symbolic links
	-x		--typeOther		Consider only files that are neither of directory (d), regular file (f) or symlink (l).
	-r		--regex		Use full regular expression syntax for the patterns specified by the name operand (This option is ignored if no name operand is specified).
	-i		--ignoreCase		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).
	-n		--timeNewer		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).
	-o		--timeOlder		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).
	-c		--timeCreate		The time operand refers to the creation time of the file (This option is ignored if no time operand is specified).
	-a		--timeAccess		The time operand refers to the last access time of the file (This option is ignored if no time operand is specified).
	-m		--timeModified		The time operand refers to the last modification time of the file (the default) (This option is ignored if no time operand is specified).
	-z		--print0		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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.unix4j.unix.find.FindOptions

FindOptions.Default

Enum Constant Summary

Enum Constants

Enum Constant and Description
ignoreCase Option --ignoreCase, -i: Use case insensitive matching when applying the file name pattern specified by the name operand
print0 Option --print0, -z: Print the full file name on the standard output, followed by a null character (instead of the newline character used by default).
regex Option --regex, -r: Use full regular expression syntax for the patterns specified by the name operand
timeAccess Option --timeAccess, -a: The time operand refers to the last access time of the file
timeCreate Option --timeCreate, -c: The time operand refers to the creation time of the file
timeModified Option --timeModified, -m: The time operand refers to the last modification time of the file (the default)
timeNewer Option --timeNewer, -n: Consider only files that have been created, modified or accessed after or at the time specified by the time operand (the default)
timeOlder Option --timeOlder, -o: Consider only files that have been created, modified or accessed before or at the time specified by the time operand
typeDirectory Option --typeDirectory, -d: Consider only directories
typeFile Option --typeFile, -f: Consider only regular files
typeOther Option --typeOther, -x: Consider only files that are neither of directory (d), regular file (f) or symlink (l).
typeSymlink Option --typeSymlink, -l: Consider only symbolic links

Field Summary

Fields inherited from interface org.unix4j.unix.find.FindOptions

CONVERTER, EMPTY

Method Summary

Modifier and Type	Method and Description
char	acronym() Returns a one letter acronym for this option.
EnumSet<FindOption>	asSet() Returns a new set with this active option.
static FindOption	findByAcronym(char acronym) Returns the option with the given acronym, or null if no such option is found.
boolean	isSet(FindOption option) Returns true if the specified option is set and false otherwise
Iterator<FindOption>	iterator() Returns an immutable iterator returning o single element: this option.
Class<FindOption>	optionType() Returns the option type class, usually an enum.
int	size() Returns 1 as this is a set with a single element: this option
boolean	useAcronymFor(FindOption option) Returns true if the acronym should be used for the specified option in string representations.
static FindOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static FindOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.unix4j.option.Option

name

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Enum Constant Detail

typeDirectory

public static final FindOption typeDirectory

Option --typeDirectory, -d: Consider only directories

typeFile

public static final FindOption typeFile

Option --typeFile, -f: Consider only regular files

typeSymlink

public static final FindOption typeSymlink

Option --typeSymlink, -l: Consider only symbolic links

typeOther

public static final FindOption typeOther

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

regex

public static final FindOption regex

Option --regex, -r: Use full regular expression syntax for the patterns specified by the name operand

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

ignoreCase

public static final FindOption ignoreCase

Option --ignoreCase, -i: 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).

timeNewer

public static final FindOption timeNewer

Option --timeNewer, -n: 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).

timeOlder

public static final FindOption timeOlder

Option --timeOlder, -o: 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).

timeCreate

public static final FindOption timeCreate

Option --timeCreate, -c: The time operand refers to the creation time of the file

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

timeAccess

public static final FindOption timeAccess

Option --timeAccess, -a: The time operand refers to the last access time of the file

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

timeModified

public static final FindOption timeModified

Option --timeModified, -m: The time operand refers to the last modification time of the file (the default)

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

print0

public static final FindOption print0

Option --print0, -z: 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.

Method Detail

values

public static FindOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FindOption c : FindOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FindOption valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

optionType

public Class<FindOption> optionType()

Description copied from interface: OptionSet

Returns the option type class, usually an enum.

Specified by:

optionType in interface OptionSet<FindOption>

Returns:

the option type

findByAcronym

public static FindOption findByAcronym(char acronym)

Returns the option with the given acronym, or null if no such option is found.

Parameters:

acronym - the option acronym

Returns:

the option with the given acronym or null if it is not found

acronym

public char acronym()

Description copied from interface: Option

Returns a one letter acronym for this option.

Specified by:

acronym in interface Option

Returns:

the acronym character used for this option.

isSet

public boolean isSet(FindOption option)

Description copied from interface: OptionSet

Returns true if the specified option is set and false otherwise

Specified by:

isSet in interface OptionSet<FindOption>

Parameters:

option - the option to test

Returns:

true if option is set in this OptionSet

asSet

public EnumSet<FindOption> asSet()

Returns a new set with this active option.

Specified by:

asSet in interface OptionSet<FindOption>

Returns:

a new set containing this option

iterator

public Iterator<FindOption> iterator()

Returns an immutable iterator returning o single element: this option.

Specified by:

iterator in interface Iterable<FindOption>

Specified by:

iterator in interface OptionSet<FindOption>

Returns:

an immutable iterator with this active option.

size

public int size()

Returns 1 as this is a set with a single element: this option

Specified by:

size in interface OptionSet<FindOption>

Returns:

one

useAcronymFor

public boolean useAcronymFor(FindOption option)

Returns true if the acronym should be used for the specified option in string representations.

This method returns always true for all options.

Specified by:

useAcronymFor in interface OptionSet<FindOption>

Parameters:

option - the option of interest

Returns:

always true indicating that option acronyms should be used in string representations for all options