Enum Depth
- All Implemented Interfaces:
Serializable
,Comparable<Depth>
,java.lang.constant.Constable
public enum Depth extends Enum<Depth>
The concept of depth for directories.
Note:
This is similar to, but not exactly the same as, the WebDAV and LDAP
concepts of depth.
-
Nested Class Summary
-
Enum Constant Summary
Enum Constants Enum Constant Description empty
Just the named directory D, no entries.exclude
Exclude (i.e, don't descend into) directory D.files
D + its file children, but not subdirs.immediates
D + immediate children (D and its entries).infinity
D + all descendants (full recursion from D).unknown
Depth undetermined or ignored. -
Method Summary
Modifier and Type Method Description static Depth
infinityOrEmpty(boolean recurse)
static Depth
infinityOrFiles(boolean recurse)
static Depth
infinityOrImmediates(boolean recurse)
static Depth
unknownOrEmpty(boolean recurse)
static Depth
unknownOrFiles(boolean recurse)
static Depth
unknownOrImmediates(boolean recurse)
static Depth
valueOf(String name)
Returns the enum constant of this type with the specified name.static Depth[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
unknown
Depth undetermined or ignored. -
exclude
Exclude (i.e, don't descend into) directory D. -
empty
Just the named directory D, no entries. Updates will not pull in any files or subdirectories not already present. -
files
D + its file children, but not subdirs. Updates will pull in any files not already present, but not subdirectories. -
immediates
D + immediate children (D and its entries). Updates will pull in any files or subdirectories not already present; those subdirectories' this_dir entries will have depth-empty. -
infinity
D + all descendants (full recursion from D). Updates will pull in any files or subdirectories not already present; those subdirectories' this_dir entries will have depth-infinity. Equivalent to the pre-1.5 default update behavior.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-
infinityOrEmpty
-
infinityOrFiles
-
infinityOrImmediates
- Returns:
- A depth value of
infinity
whenrecurse
istrue
, orimmediates
otherwise.
-
unknownOrEmpty
-
unknownOrFiles
-
unknownOrImmediates
- Returns:
- A depth value of
unknown
whenrecurse
istrue
, orimmediates
otherwise.
-