org.apache.jackrabbit.webdav.property

Class PropContainer

java.lang.Object

org.apache.jackrabbit.webdav.property.PropContainer

All Implemented Interfaces:

DavConstants, XmlSerializable

Direct Known Subclasses:

DavPropertyNameSet, DavPropertySet

public abstract class PropContainer
extends Object
implements XmlSerializable, DavConstants

PropContainer...

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
PropContainer()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addContent(Object contentEntry) Deprecated. Use addContent(PropEntry) instead.
abstract boolean	addContent(PropEntry contentEntry) Tries to add the specified entry to the PropContainer and returns a boolean indicating whether the content could be added to the internal set/map.
abstract boolean	contains(DavPropertyName name) Returns true if this PropContainer contains a content element that matches the given DavPropertyName.
abstract Collection<? extends PropEntry>	getContent() Returns the collection that contains all the content elements of this PropContainer.
abstract int	getContentSize() Returns the number of property related content elements that are present in this PropContainer.
abstract boolean	isEmpty() Returns true if the PropContainer does not yet contain any content elements.
Element	toXml(Document document) Returns the xml representation of a property related set with the following format:

Methods inherited from class java.lang.Object

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

Constructor Detail

PropContainer

public PropContainer()

Method Detail

addContent

public boolean addContent(Object contentEntry)

Deprecated. Use addContent(PropEntry) instead.

Tries to add the specified object to the PropContainer and returns a boolean indicating whether the content could be added to the internal set/map.

Parameters:

contentEntry -

Returns:

true if the object could be added; false otherwise

addContent

public abstract boolean addContent(PropEntry contentEntry)

Tries to add the specified entry to the PropContainer and returns a boolean indicating whether the content could be added to the internal set/map.

Parameters:

contentEntry -

Returns:

true if the object could be added; false otherwise

isEmpty

public abstract boolean isEmpty()

Returns true if the PropContainer does not yet contain any content elements.

Returns:

true if this container is empty.

getContentSize

public abstract int getContentSize()

Returns the number of property related content elements that are present in this PropContainer.

Returns:

number of content elements

getContent

public abstract Collection<? extends PropEntry> getContent()

Returns the collection that contains all the content elements of this PropContainer.

Returns:

collection representing the contents of this PropContainer.

contains

public abstract boolean contains(DavPropertyName name)

Returns true if this PropContainer contains a content element that matches the given DavPropertyName.

Parameters:

name -

Returns:

true if any of the content elements (be it a DavProperty or a DavPropertyName only) matches the given name.

toXml

public Element toXml(Document document)

Returns the xml representation of a property related set with the following format:

 <!ELEMENT prop (ANY) >
 where ANY consists of a list of elements each reflecting the xml
 representation of the entries returned by getContent().
 

Specified by:

toXml in interface XmlSerializable

Parameters:

document - to be used as factory.

Returns:

a w3c element representing this object

See Also:

XmlSerializable.toXml(Document)