|
||||||||||
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.PropFind
public class PropFind
An element editor for the WebDAV propfind element. See RFC2518 section 12.14 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.
Prop
Field Summary | |
---|---|
protected static String[] |
childNames
An ordered collection of the element names of the propfind 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 | |
---|---|
PropFind(Element root)
Creates a new editor on the given WebDAV propfind element. |
Method Summary | |
---|---|
static PropFind |
create(Document document)
Creates a new WebDAV propfind element and sets it as the root of the given document. |
Prop |
getProp()
Returns this propfind's prop. |
boolean |
isAllProp()
Returns true iff this propfind is in the "all prop"
form. |
boolean |
isProp()
Returns true iff this propfind is in the "prop" form. |
boolean |
isPropName()
Returns true iff this propfind is in the "prop name"
form. |
void |
setIsAllProp(boolean isAllProp)
Sets whether this propfind is in the "all prop" form. |
void |
setIsPropName(boolean isPropName)
Sets whether this propfind is in the "prop name" form. |
Prop |
setProp()
Creates and sets a new prop on this propfind 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 |
---|
protected static final String[] childNames
Constructor Detail |
---|
public PropFind(Element root) throws MalformedElementException
root
- a propfind element
MalformedElementException
- if there is reason to
believe that the element is not well formedMethod Detail |
---|
public static PropFind create(Document document)
null
, and must not already have a
root element.
document
- the document that will become the root of a new
propfind element
public Prop getProp() throws MalformedElementException
MalformedElementException
- if there is reason to believe that
this editor's underlying element is not well formed, or if
this propfind is not in the "prop" formpublic boolean isAllProp() throws MalformedElementException
true
iff this propfind is in the "all prop"
form.
MalformedElementException
- if there is reason to believe that
this editor's underlying element is not well formedpublic boolean isProp() throws MalformedElementException
true
iff this propfind is in the "prop" form.
MalformedElementException
- if there is reason to believe that
this editor's underlying element is not well formedpublic boolean isPropName() throws MalformedElementException
true
iff this propfind is in the "prop name"
form.
MalformedElementException
- if there is reason to believe that
this editor's underlying element is not well formedpublic void setIsAllProp(boolean isAllProp)
isAllProp
- boolean indicating whether this propfind will be in the
"all prop" formpublic void setIsPropName(boolean isPropName)
isPropName
- boolean indicating whether this propfind will be in the
"prop name" formpublic Prop setProp()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |