org.eclipse.webdav.dom
Class LockDiscovery

java.lang.Object
  extended by org.eclipse.webdav.dom.ElementEditor
      extended by org.eclipse.webdav.dom.Property
          extended by org.eclipse.webdav.dom.LockDiscovery

public class LockDiscovery
extends Property

An element editor for the WebDAV lockdiscovery element. See RFC2518 section 13.8 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:
ActiveLock

Field Summary
protected static String[] childNames
          An ordered collection of the element names of the lockdiscovery element's children.
 
Fields inherited from class org.eclipse.webdav.dom.ElementEditor
DAV_NS, root, XML_NS_NAME, XML_NS_PREFIX, XML_PREFIX
 
Constructor Summary
LockDiscovery(Element root)
          Creates a new editor on the given WebDAV lockdiscovery element.
 
Method Summary
 ActiveLock addActiveLock()
          Creates and adds a new activelock on this lockdiscovery and returns an editor on it.
 Enumeration getActiveLocks()
          Returns an Enumeration over this lockdiscovery's ActiveLocks.
 
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
 

Field Detail

childNames

protected static final String[] childNames
An ordered collection of the element names of the lockdiscovery element's children.

Constructor Detail

LockDiscovery

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

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

addActiveLock

public ActiveLock addActiveLock()
Creates and adds a new activelock on this lockdiscovery and returns an editor on it.

Returns:
an editor on an activelock element

getActiveLocks

public Enumeration getActiveLocks()
                           throws MalformedElementException
Returns an Enumeration over this lockdiscovery's ActiveLocks.

Returns:
an Enumeration of ActiveLocks
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.