org.eclipse.webdav.dom
Class PropertyUpdate

java.lang.Object
  extended by org.eclipse.webdav.dom.ElementEditor
      extended by org.eclipse.webdav.dom.PropertyUpdate

public class PropertyUpdate
extends ElementEditor

An element editor for the WebDAV propertyupdate element. See RFC2518 section 12.13 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:
Prop

Nested Class Summary
 class PropertyUpdate.Directive
          An editor for a generic element that is a child of a WebDAV prop element, which, in turn, is a child of a WebDAV set or remove element.
 
Field Summary
 
Fields inherited from class org.eclipse.webdav.dom.ElementEditor
DAV_NS, root, XML_NS_NAME, XML_NS_PREFIX, XML_PREFIX
 
Constructor Summary
PropertyUpdate(Element root)
          Creates a new editor on the given WebDAV propertyupdate element.
 
Method Summary
 Prop addRemove()
          Adds a remove to the given propertyupdate and returns an editor on its prop.
 Prop addSet()
          Adds a set to the given propertyupdate and returns an editor on its prop.
static PropertyUpdate create(Document document)
          Creates a new WebDAV propertyupdate element and sets it as the root of the given document.
 Enumeration getSetsAndRemoves()
          Returns an Enumeration over this propertyupdate's set and remove property elements.
 
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

PropertyUpdate

public PropertyUpdate(Element root)
               throws MalformedElementException
Creates a new editor on the given WebDAV propertyupdate element. The element is assumed to be well formed.

Parameters:
root - a propertyupdate element
Throws:
MalformedElementException - if there is reason to believe that the element is not well formed
Method Detail

addRemove

public Prop addRemove()
Adds a remove to the given propertyupdate and returns an editor on its prop.

Returns:
an editor on a new prop

addSet

public Prop addSet()
Adds a set to the given propertyupdate and returns an editor on its prop.

Returns:
an editor on a new prop

create

public static PropertyUpdate create(Document document)
Creates a new WebDAV propertyupdate element and sets it as the root of the given document. Returns an editor on the new propertyupdate element. The document must not be null, and must not already have a root element.

Parameters:
document - the document that will become the root of a new propertyupdate element
Returns:
an element editor on a propertyupdate element

getSetsAndRemoves

public Enumeration getSetsAndRemoves()
                              throws MalformedElementException
Returns an Enumeration over this propertyupdate's set and remove property elements.

Returns:
an Enumeration of PropertyUpdate.Directives
Throws:
MalformedElementException - if there is reason to believe that this editor's underlying element is not well formed


Copyright © 2001-2014 JBoss by Red Hat. All Rights Reserved.