DepthHeader (Apache Jackrabbit 2.23.1-beta API)

java.lang.Object
- org.apache.jackrabbit.webdav.header.DepthHeader

All Implemented Interfaces:: DavConstants, Header

public class DepthHeader
extends Object
implements Header, DavConstants

DepthHeader...

Field Summary
- Fields inherited from interface org.apache.jackrabbit.webdav.DavConstants
  creationDateFormat, DEPTH_0, DEPTH_1, DEPTH_INFINITY, DEPTH_INFINITY_S, HEADER_AUTHORIZATION, HEADER_CONTENT_LANGUAGE, HEADER_CONTENT_LENGTH, HEADER_CONTENT_TYPE, HEADER_DAV, HEADER_DEPTH, HEADER_DESTINATION, HEADER_ETAG, HEADER_IF, HEADER_LAST_MODIFIED, HEADER_LOCK_TOKEN, HEADER_OVERWRITE, HEADER_TIMEOUT, INFINITE_TIMEOUT, modificationDateFormat, NAMESPACE, OPAQUE_LOCK_TOKEN_PREFIX, PROPERTY_CREATIONDATE, PROPERTY_DISPLAYNAME, PROPERTY_GETCONTENTLANGUAGE, PROPERTY_GETCONTENTLENGTH, PROPERTY_GETCONTENTTYPE, PROPERTY_GETETAG, PROPERTY_GETLASTMODIFIED, PROPERTY_LOCKDISCOVERY, PROPERTY_RESOURCETYPE, PROPERTY_SOURCE, PROPERTY_SUPPORTEDLOCK, PROPFIND_ALL_PROP, PROPFIND_ALL_PROP_INCLUDE, PROPFIND_BY_PROPERTY, PROPFIND_PROPERTY_NAMES, TIMEOUT_INFINITE, UNDEFINED_TIME, UNDEFINED_TIMEOUT, XML_ACTIVELOCK, XML_ALLPROP, XML_COLLECTION, XML_DEPTH, XML_DST, XML_EXCLUSIVE, XML_HREF, XML_INCLUDE, XML_KEEPALIVE, XML_LINK, XML_LOCKENTRY, XML_LOCKINFO, XML_LOCKROOT, XML_LOCKSCOPE, XML_LOCKTOKEN, XML_LOCKTYPE, XML_MULTISTATUS, XML_OMIT, XML_OWNER, XML_PROP, XML_PROPERTYBEHAVIOR, XML_PROPERTYUPDATE, XML_PROPFIND, XML_PROPNAME, XML_PROPSTAT, XML_REMOVE, XML_RESPONSE, XML_RESPONSEDESCRIPTION, XML_SET, XML_SHARED, XML_SOURCE, XML_STATUS, XML_TIMEOUT, XML_WRITE

Constructor Summary

Constructors
Constructor	Description
`DepthHeader(boolean isDeep)`	Create a new `DepthHeader` with either value `0` or `infinity`.
`DepthHeader(int depth)`	Create a new `DepthHeader` from the given integer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getDepth()`
`String`	`getHeaderName()`	Return `Depth`
`String`	`getHeaderValue()`	Returns the header value.
`static DepthHeader`	`parse(javax.servlet.http.HttpServletRequest request, int defaultValue)`	Retrieve the Depth header from the given request object and parse the value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DepthHeader
```
public DepthHeader(int depth)
```
    Create a new DepthHeader from the given integer.
    
    Parameters:
    
    depth -
  - DepthHeader
```
public DepthHeader(boolean isDeep)
```
    Create a new DepthHeader with either value 0 or infinity.
    
    Parameters:
    
    isDeep -
- Method Detail
  - getDepth
```
public int getDepth()
```
    Returns:
    
    integer representation of the depth indicated by the given header.
  - getHeaderName
```
public String getHeaderName()
```
    Return Depth
    
    Specified by:
    
    getHeaderName in interface Header
    
    Returns:
    
    Depth
    
    See Also:
    
    DavConstants.HEADER_DEPTH, Header.getHeaderName()
  - getHeaderValue
```
public String getHeaderValue()
```
    Returns the header value.
    
    Specified by:
    
    getHeaderValue in interface Header
    
    Returns:
    
    header value
    
    See Also:
    
    Header.getHeaderValue()
  - parse
```
public static DepthHeader parse(javax.servlet.http.HttpServletRequest request,
                                int defaultValue)
```
    Retrieve the Depth header from the given request object and parse the value. If no header is present or the value is empty String, the defaultValue is used ot build a new DepthHeader instance.
    
    Parameters:
    
    request -
    
    defaultValue -
    
    Returns:
    
    a new DepthHeader instance