org.apache.jackrabbit.webdav.property
Interface DavProperty

All Superinterfaces:
DavConstants
All Known Implementing Classes:
AbstractDavProperty

public interface DavProperty
extends DavConstants

The Property class represents a Property of a WebDAV resource. The #hashCode() and #equals(Object) METHODS are overridden in a way, that the name and value of the property are respected. this means, an property is equal to another, if the names and values are equal.


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, NO_OVERWRITE, 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_BY_PROPERTY, PROPFIND_PROPERTY_NAMES, TIMEOUT_INFINITE, UNDEFINED_TIMEOUT, XML_ACTIVELOCK, XML_ALLPROP, XML_COLLECTION, XML_DEPTH, XML_DST, XML_EXCLUSIVE, XML_HREF, XML_KEEPALIVE, XML_LINK, XML_LOCKENTRY, XML_LOCKINFO, 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
 
Method Summary
 DavPropertyName getName()
          Returns the name of this property
 Object getValue()
          Returns the value of this property
 boolean isProtected()
          Return true if this property is protected.
 org.jdom.Element toXml()
          Return a JDOM element representation of this property.
 

Method Detail

toXml

public org.jdom.Element toXml()
Return a JDOM element representation of this property. The value of the property will be added as text or as child element.
 new DavProperty("displayname", "WebDAV Directory").toXml()
 gives a element like:
 <D:displayname>WebDAV Directory</D:displayname>

 new DavProperty("resourcetype", new Element("collection")).toXml()
 gives a element like:
 <D:resourcetype><D:collection/></D:resourcetype>

 Element[] customVals = { new Element("bla", customNamespace), new Element("bli", customNamespace) };
 new DavProperty("custom-property", customVals, customNamespace).toXml()
 gives an element like
 <Z:custom-property>
    <Z:bla/>
    <Z:bli/>
 </Z:custom-property>
 

Returns:
a JDOM element of this property

getName

public DavPropertyName getName()
Returns the name of this property

Returns:
the name of this property

getValue

public Object getValue()
Returns the value of this property

Returns:
the value of this property

isProtected

public boolean isProtected()
Return true if this property is protected. A protected property will not be returned in a DAV:allprop PROPFIND request and cannot be set/removed with a PROPPATCH request.

Returns:
true, if this property is protected.


Copyright © 2005 . All Rights Reserved.