org.apache.webdav.lib.methods

Interface DepthSupport

Known Implementing Classes:
AclReportMethod, LockMethod, PropFindMethod, ReportMethod, SubscribeMethod, VersionControlMethod

public interface DepthSupport

Methods that can act on collections (for example, DELETE, LOCK, PROPFIND, etc.) support a depth header. The depth header indicates that the method applies to either:
  1. the collection (depth 0);
  2. the collection and its immediate contents (depth 1); or
  3. the collection, its contents and all subcollections (depth infinity).

Field Summary

static int
DEPTH_0
Request with depth 0.
static int
DEPTH_1
Request with depth 1.
static int
DEPTH_INFINITY
Request with depth infinity.

Method Summary

int
getDepth()
Depth getter.
void
setDepth(int depth)
Depth setter.

Field Details

DEPTH_0

public static final int DEPTH_0
Request with depth 0.
Field Value:
0

DEPTH_1

public static final int DEPTH_1
Request with depth 1.
Field Value:
1

DEPTH_INFINITY

public static final int DEPTH_INFINITY
Request with depth infinity.

Method Details

getDepth

public int getDepth()
Depth getter.
Returns:
int depth value

setDepth

public void setDepth(int depth)
Depth setter.
Parameters:
depth - New depth value