|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.webdav.dom.ElementEditor
org.eclipse.webdav.dom.LockInfo
public class LockInfo
An element editor for the WebDAV lockinfo element. See RFC2518 section 12.6 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.
Owner
Field Summary | |
---|---|
static String[] |
childNames
An ordered collection of the element names of the lockinfo 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 | |
---|---|
LockInfo(Element root)
Creates a new editor on the given WebDAV lockinfo element. |
Method Summary | |
---|---|
static LockInfo |
create(Document document)
Creates a new WebDAV lockinfo element and sets it as the root of the given document. |
Owner |
getOwner()
Returns this lockinfo's owner, or null if this lockinfo
has no owner. |
boolean |
isShared()
Returns true if this lockinfo is shared and
false if it is exclusive. |
void |
setIsShared(boolean isShared)
Sets whether this lockinfo is shared or exclusive. |
Owner |
setOwner()
Sets the owner on this lockinfo and returns an editor on it. |
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 |
---|
public static final String[] childNames
Constructor Detail |
---|
public LockInfo(Element root) throws MalformedElementException
root
- a lockinfo element
MalformedElementException
- if there is reason to
believe that the element is not well formedMethod Detail |
---|
public static LockInfo create(Document document)
null
, and must not already have a
root element.
document
- the document that will become the root of a new
lockinfo element
public Owner getOwner() throws MalformedElementException
null
if this lockinfo
has no owner.
null
MalformedElementException
- if there is reason to believe that
this editor's underlying element is not well formedpublic boolean isShared() throws MalformedElementException
true
if this lockinfo is shared and
false
if it is exclusive.
MalformedElementException
- if there is reason to believe that
this editor's underlying element is not well formedpublic void setIsShared(boolean isShared)
true
, the lockinfo is set as shared, otherwise, the
lockinfo is set as exclusive.
isShared
- a boolean indicating whether this lockinfo will be
set to be shared or exclusivepublic Owner setOwner()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |