Package org.tmatesoft.svn.core
Class SVNDepth
java.lang.Object
org.tmatesoft.svn.core.SVNDepth
- All Implemented Interfaces:
Comparable
This class contains enumeration that describes depth,
that is used.
The order of these depths is important: the higher the number,
the deeper it descends. You can use it to compare two depths
numerically to decide which goes deeper.
- Since:
- 1.2
- Version:
- 1.3
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final SVNDepth
Just the named directory D, no entries.static final SVNDepth
Exclude (don't descend into) directory D.static final SVNDepth
D and its file children, but not subdirectories.static final SVNDepth
D and its immediate children (D and its entries).static final SVNDepth
D and all descendants (full recursion from D).private int
private String
static final SVNDepth
Depth undetermined or ignored. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic String
Appropriate name ofdepth
is returned.int
Compares this object to another one.boolean
Says whether this object andobj
are equal.static SVNDepth
fromID
(int id) Based on depth id returnsSVNDepth
value.static SVNDepth
fromRecurse
(boolean recurse) Treats recursion asINFINITY
depth andFILES
otherwisestatic SVNDepth
fromString
(String string) Based on string value findsSVNDepth
value.int
getId()
Gets numerical Id of depthstatic SVNDepth
getInfinityOrEmptyDepth
(boolean recurse) ReturnsINFINITY
ifrecurse
istrue
, else returnsEMPTY
.static SVNDepth
getInfinityOrFilesDepth
(boolean recurse) The same asgetInfinityOrEmptyDepth(boolean)
, butFILES
is returned when recursive.static SVNDepth
getInfinityOrImmediatesDepth
(boolean recurse) The same asgetInfinityOrEmptyDepth(boolean)
, butIMMEDIATES
is returned when recursive.getName()
Gets the name of depthstatic SVNDepth
getUnknownOrEmptyDepth
(boolean recurse) ReturnsUNKNOWN
ifrecurse
istrue
, else returnsEMPTY
.static SVNDepth
getUnknownOrFilesDepth
(boolean recurse) The same asgetUnknownOrEmptyDepth(boolean)
, butFILES
is returned when recursive.static SVNDepth
getUnknownOrImmediatesDepth
(boolean recurse) The same asgetUnknownOrEmptyDepth(boolean)
, butIMMEDIATES
is returned when recursive.boolean
Returns a recursion boolean based on depth.static boolean
recurseFromDepth
(SVNDepth depth) Based on depth determines if it is recursive or not.toString()
Returns a string representation of this object.
-
Field Details
-
UNKNOWN
Depth undetermined or ignored. -
EXCLUDE
Exclude (don't descend into) directory D. -
EMPTY
Just the named directory D, no entries. For instance, update will not pull in any files or subdirectories. -
FILES
D and its file children, but not subdirectories. For instance, updates will pull in any files, but not subdirectories. -
IMMEDIATES
D and its immediate children (D and its entries). Updates will pull in any files or subdirectories without any children. -
INFINITY
D and all descendants (full recursion from D). For instance, updates will pull in any files or subdirectories recursively. -
myId
private int myId -
myName
-
-
Constructor Details
-
SVNDepth
-
-
Method Details
-
getId
public int getId()Gets numerical Id of depth- Returns:
- depth Id
- Since:
- SVNKit 1.2.0, SVN 1.5.0
-
getName
Gets the name of depth- Returns:
- depth name
- Since:
- SVNKit 1.2.0, SVN 1.5.0
-
toString
Returns a string representation of this object. -
isRecursive
public boolean isRecursive()Returns a recursion boolean based on depth. Although much code has been converted to use depth, some code still takes a recurse boolean. In most cases, it makes sense to treat unknown or infinite depth as recursive, and any other depth as non-recursive (which in turn usually translates toFILES
).- Returns:
- if recursion is used
- Since:
- SVNKit 1.2.0, SVN 1.5.0
-
compareTo
Compares this object to another one.- Specified by:
compareTo
in interfaceComparable
- Parameters:
o
- object to compare with- Returns:
-1
ifo
is null, or not anSVNDepth
instance, or itsid
is greater than this object's id;0
if ids this object ando
are equal;1
if id of this object is greater than the one ofo
.
-
equals
Says whether this object andobj
are equal. -
asString
Appropriate name ofdepth
is returned. Ifdepth
does not represent a recognized depth,"INVALID-DEPTH"
is returned.- Parameters:
depth
- depth, which name needs to be returned- Returns:
- the name of depth
- Since:
- SVNKit 1.2.0, SVN 1.5.0
-
recurseFromDepth
Based on depth determines if it is recursive or not. In most cases, it makes sense to treat unknown or infinite depth as recursive, and any other depth as non-recursive- Parameters:
depth
- depth value- Returns:
- if it is recursive
- Since:
- SVNKit 1.2.0, SVN 1.5.0
- See Also:
-
fromRecurse
Treats recursion asINFINITY
depth andFILES
otherwise- Parameters:
recurse
- indicator of recursion- Returns:
- depth
- Since:
- SVNKit 1.2.0, SVN 1.5.0
- See Also:
-
fromString
Based on string value findsSVNDepth
value.- Parameters:
string
- depth value represented by string- Returns:
- depth
- Since:
- SVNKit 1.2.0, SVN 1.5.0
-
fromID
Based on depth id returnsSVNDepth
value.- Parameters:
id
- depth id- Returns:
- depth
- Since:
- SVNKit 1.2.0, SVN 1.5.0
-
getInfinityOrEmptyDepth
ReturnsINFINITY
ifrecurse
istrue
, else returnsEMPTY
. Code should never need to use this, it is called only from pre-depth APIs, for compatibility.- Parameters:
recurse
- boolean- Returns:
- depth
- Since:
- SVNKit 1.2.0, SVN 1.5.0
-
getInfinityOrFilesDepth
The same asgetInfinityOrEmptyDepth(boolean)
, butFILES
is returned when recursive. Code should never need to use this, it is called only from pre-depth APIs, for compatibility.- Parameters:
recurse
- boolean- Returns:
- depth
- Since:
- SVNKit 1.2.0, SVN 1.5.0
-
getInfinityOrImmediatesDepth
The same asgetInfinityOrEmptyDepth(boolean)
, butIMMEDIATES
is returned when recursive. Code should never need to use this, it is called only from pre-depth APIs, for compatibility.- Parameters:
recurse
- boolean- Returns:
- depth
- Since:
- SVNKit 1.2.0, SVN 1.5.0
-
getUnknownOrEmptyDepth
ReturnsUNKNOWN
ifrecurse
istrue
, else returnsEMPTY
. Code should never need to use this, it is called only from pre-depth APIs, for compatibility.- Parameters:
recurse
- boolean- Returns:
- depth
- Since:
- SVNKit 1.2.0, SVN 1.5.0
-
getUnknownOrFilesDepth
The same asgetUnknownOrEmptyDepth(boolean)
, butFILES
is returned when recursive. Code should never need to use this, it is called only from pre-depth APIs, for compatibility.- Parameters:
recurse
- boolean- Returns:
- depth
- Since:
- SVNKit 1.2.0, SVN 1.5.0
-
getUnknownOrImmediatesDepth
The same asgetUnknownOrEmptyDepth(boolean)
, butIMMEDIATES
is returned when recursive. Code should never need to use this, it is called only from pre-depth APIs, for compatibility.- Parameters:
recurse
- boolean- Returns:
- depth
- Since:
- SVNKit 1.2.0, SVN 1.5.0
-