Class Depth


  • public final class Depth
    extends java.lang.Object
    The concept of depth for directories. Note: This is similar to, but not exactly the same as, the WebDAV and LDAP concepts of depth.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int empty
      Just the named directory D, no entries.
      static int exclude
      Exclude (i.e, don't descend into) directory D.
      static int files
      D + its file children, but not subdirs.
      static int immediates
      D + immediate children (D and its entries).
      static int infinity
      D + all descendants (full recursion from D).
      static int unknown
      Depth undetermined or ignored.
    • Constructor Summary

      Constructors 
      Constructor Description
      Depth()  
    • Field Detail

      • unknown

        public static final int unknown
        Depth undetermined or ignored.
        See Also:
        Constant Field Values
      • exclude

        public static final int exclude
        Exclude (i.e, don't descend into) directory D.
        See Also:
        Constant Field Values
      • empty

        public static final int empty
        Just the named directory D, no entries. Updates will not pull in any files or subdirectories not already present.
        See Also:
        Constant Field Values
      • files

        public static final int files
        D + its file children, but not subdirs. Updates will pull in any files not already present, but not subdirectories.
        See Also:
        Constant Field Values
      • immediates

        public static final int 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.
        See Also:
        Constant Field Values
      • infinity

        public static final int 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.
        See Also:
        Constant Field Values
    • Constructor Detail

      • Depth

        public Depth()
    • Method Detail

      • infinityOrEmpty

        public static final int infinityOrEmpty​(boolean recurse)
        Returns:
        A depth value of infinity when recurse is true, or empty otherwise.
      • infinityOrFiles

        public static final int infinityOrFiles​(boolean recurse)
        Returns:
        A depth value of infinity when recurse is true, or files otherwise.
      • infinityOrImmediates

        public static final int infinityOrImmediates​(boolean recurse)
        Returns:
        A depth value of infinity when recurse is true, or immediates otherwise.
      • unknownOrEmpty

        public static final int unknownOrEmpty​(boolean recurse)
        Returns:
        A depth value of unknown when recurse is true, or empty otherwise.
      • unknownOrFiles

        public static final int unknownOrFiles​(boolean recurse)
        Returns:
        A depth value of unknown when recurse is true, or files otherwise.
      • unknownOrImmediates

        public static final int unknownOrImmediates​(boolean recurse)
        Returns:
        A depth value of unknown when recurse is true, or immediates otherwise.
      • toADepth

        public static Depth toADepth​(int depth)
      • fromADepth

        public static int fromADepth​(Depth aDepth)