org.eclipse.webdav.dom
Class Prop

java.lang.Object
  org.eclipse.webdav.dom.ElementEditor
      org.eclipse.webdav.dom.Prop

public class Prop
extends ElementEditor

An element editor for the WebDAV prop element. See RFC2518 section 12.11 for the element's definition.

Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

See Also:

PropStat, PropertyUpdate, PropFind, Property

Field Summary

Fields inherited from class org.eclipse.webdav.dom.ElementEditor

DAV_NS, root, XML_NS_NAME, XML_NS_PREFIX, XML_PREFIX

Constructor Summary

Prop(Element root)
Creates a new editor on the given WebDAV prop element.

Method Summary

void	addProperty(Element element) Creates a clone of the given element and adds it to this prop.
void	addPropertyName(QualifiedName name) Creates a new element with the given name and adds it to this prop.
Enumeration	getProperties() Returns an Enumeration over this prop's property Elements.
Enumeration	getPropertyNames() Returns an Enumeration over this prop's property QualifiedNames.

Methods inherited from class org.eclipse.webdav.dom.ElementEditor

addChild, addChild, addChild, appendChild, appendChild, cloneNode, create, declareNS, decodeHref, encodeHref, ensure, ensure, ensureDAVElement, ensureDAVElement, ensureNotNull, ensureNull, ensureText, extractElement, extractNode, getChild, getChildElement, getChildText, getDAVChild, getElement, getFirstChild, getFirstChild, getFirstText, getLastChild, getNamespaces, getNamespaces, getNextSibling, getNextSibling, getNextSibling, getNSLocalName, getNSLocalName, getNSName, getNSPrefix, getNSPrefix, getQualifiedName, getSibling, getText, getTwin, hasChild, insertBefore, insertBefore, isDAVElement, isDAVElement, isElement, isText, makeNSStandalone, reduceNS, reduceNS, resolve, setChild, setChild, setChild

Methods inherited from class java.lang.Object

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

Constructor Detail

Prop

public Prop(Element root)
     throws MalformedElementException

Creates a new editor on the given WebDAV prop element. The element is assumed to be well formed.

Parameters:

root - a prop element

Throws:

MalformedElementException - if there is reason to believe that the element is not well formed

Method Detail

addProperty

public void addProperty(Element element)
                 throws MalformedElementException

Creates a clone of the given element and adds it to this prop. The element must not be null.

Parameters:

element - any element

Throws:

MalformedElementException - if there is reason to believe that the given element is not well formed

addPropertyName

public void addPropertyName(QualifiedName name)

Creates a new element with the given name and adds it to this prop. The name must not be null and its qualifier and local name must not be null and must not be the empty string.

Parameters:

name - the QualifiedName of the property to add

getProperties

public Enumeration getProperties()
                          throws MalformedElementException

Returns an Enumeration over this prop's property Elements.

Throws:

MalformedElementException - if there is reason to believe that this editor's underlying element is not well formed

getPropertyNames

public Enumeration getPropertyNames()
                             throws MalformedElementException

Returns an Enumeration over this prop's property QualifiedNames.

Throws:

MalformedElementException - if there is reason to believe that this editor's underlying element is not well formed