org.apache.jackrabbit.webdav.version.report

Class SupportedReportSetProperty

java.lang.Object

org.apache.jackrabbit.webdav.property.AbstractDavProperty<Set<ReportType>>

org.apache.jackrabbit.webdav.version.report.SupportedReportSetProperty

All Implemented Interfaces:

DavConstants, DavProperty<Set<ReportType>>, PropEntry, XmlSerializable

public class SupportedReportSetProperty
extends AbstractDavProperty<Set<ReportType>>

SupportedReportSetProperty represents the DAV:supported-report-set property defined by RFC 3253. It identifies the reports that are supported by the given resource.

 <!ELEMENT supported-report-set (supported-report*)>
 <!ELEMENT supported-report report>
 <!ELEMENT report ANY>
 ANY value: a report element type
 

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 and Description
SupportedReportSetProperty() Create a new empty SupportedReportSetProperty.
SupportedReportSetProperty(ReportType[] reportTypes) Create a new SupportedReportSetProperty property.

Method Summary

Modifier and Type	Method and Description
void	addReportType(ReportType reportType) Add an additional report type to this property's value.
Set<ReportType>	getValue() Returns a set of report types.
boolean	isSupportedReport(ReportInfo reqInfo) Returns true if the report type indicated in the specified RequestInfo object is included in the supported reports.
Element	toXml(Document document) Returns the Xml representation of this property.

Methods inherited from class org.apache.jackrabbit.webdav.property.AbstractDavProperty

equals, getName, hashCode, isInvisibleInAllprop

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SupportedReportSetProperty

public SupportedReportSetProperty()

Create a new empty SupportedReportSetProperty.

SupportedReportSetProperty

public SupportedReportSetProperty(ReportType[] reportTypes)

Create a new SupportedReportSetProperty property.

Parameters:

reportTypes - that are supported by the resource having this property.

Method Detail

addReportType

public void addReportType(ReportType reportType)

Add an additional report type to this property's value.

Parameters:

reportType -

isSupportedReport

public boolean isSupportedReport(ReportInfo reqInfo)

Returns true if the report type indicated in the specified RequestInfo object is included in the supported reports.

Parameters:

reqInfo -

Returns:

true if the requested report is supported.

getValue

public Set<ReportType> getValue()

Returns a set of report types.

Returns:

set of ReportType.

See Also:

DavProperty.getValue()

toXml

public Element toXml(Document document)

Returns the Xml representation of this property.

Specified by:

toXml in interface XmlSerializable

Overrides:

toXml in class AbstractDavProperty<Set<ReportType>>

Parameters:

document -

Returns:

Xml representation listing all supported reports

See Also:

XmlSerializable.toXml(Document)