org.eclipse.webdav.dom
Class LockEntry

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

public class LockEntry
extends ElementEditor

An element editor for the WebDAV lockentry element. See RFC2518 section 12.5 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:
SupportedLock

Field Summary
protected static String[] childNames
          An ordered collection of the element names of the lockentry 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
LockEntry(Element root)
          Creates a new editor on the given WebDAV lockentry element.
 
Method Summary
 boolean isShared()
          Returns true if this lockentry is shared and false if it is exclusive.
 void setIsShared(boolean isShared)
          Sets whether this lockentry is shared or exclusive.
 
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 lockentry element's children.

Constructor Detail

LockEntry

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

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

isShared

public boolean isShared()
                 throws MalformedElementException
Returns true if this lockentry is shared and false if it is exclusive.

Returns:
a boolean indicating whether this lockentry is shared or exclusive
Throws:
MalformedElementException - if there is reason to believe that this editor's underlying element is not well formed

setIsShared

public void setIsShared(boolean isShared)
Sets whether this lockentry is shared or exclusive. If isShared is true, the lockentry is set as shared, otherwise, the lockentry is set as exclusive.

Parameters:
isShared - a boolean indicating whether this lockentry will be set to be shared or exclusive


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