|
||||||||||
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.PropertyBehavior
public class PropertyBehavior
An element editor for the WebDAV propertybehavior element. See RFC2518 section 12.12 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.
Field Summary | |
---|---|
protected static String[] |
childNames
An ordered collection of the element names of the propertybehavior element's children. |
static String[] |
fgNamesKeepAlive
An ordered collection of the element names of the propertybehavior element's children in the "keep alive" form |
static String[] |
fgNamesOmit
An ordered collection of the element names of the propertybehavior element's children in the "omit" form |
Fields inherited from class org.eclipse.webdav.dom.ElementEditor |
---|
DAV_NS, root, XML_NS_NAME, XML_NS_PREFIX, XML_PREFIX |
Constructor Summary | |
---|---|
PropertyBehavior(Element root)
Creates a new editor on the given WebDAV propertybehavior element. |
Method Summary | |
---|---|
void |
addProperty(String propertyHref)
Adds the given property href to this propertybehavior's list of live properties. |
static PropertyBehavior |
create(Document document)
Creates a new WebDAV propertybehavior element and sets it as the root of the given document. |
Enumeration |
getProperties()
Returns an Enumeration over this propertybehavior's
property hrefs. |
boolean |
isKeepAllAlive()
Returns true if this propertybehavior is in the
"keep all alive" form, otherwise, returns false . |
boolean |
isOmit()
Returns true if this propertybehavior is in the
"omit" form, otherwise, returns false . |
void |
setIsKeepAllAlive(boolean isKeepAllAlive)
Sets whether this propertybehavior is in the "keep all alive" form or not. |
void |
setIsOmit(boolean isOmit)
Sets whether this propertybehavior is in the "omit" form or not. |
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
public static String[] fgNamesOmit
public static String[] fgNamesKeepAlive
Constructor Detail |
---|
public PropertyBehavior(Element root) throws MalformedElementException
root
- a propertybehavior element
MalformedElementException
- if there is reason to
believe that the element is not well formedMethod Detail |
---|
public void addProperty(String propertyHref)
null
and the
form of this property behavior must not already be omit or
keepAllAlive.
propertyHref
- the property href to addpublic static PropertyBehavior create(Document document)
null
, and must not
already have a root element.
document
- the document that will become the root of a new
propertybehavior element
public Enumeration getProperties() throws MalformedElementException
Enumeration
over this propertybehavior's
property hrefs. The methods isMerge()
and
isKeepAllAlive
return false if this propertybehavior is
in the "keep some alive" form.
Enumeration
of String
s
MalformedElementException
- if there is reason to believe that
this editor's underlying element is not well formed, or this
propertybehavior is not in the "keep some alive" formisKeepAllAlive()
,
isOmit()
public boolean isKeepAllAlive() throws MalformedElementException
true
if this propertybehavior is in the
"keep all alive" form, otherwise, returns false
.
MalformedElementException
- if there is reason to believe that
this editor's underlying element is not well formedpublic boolean isOmit() throws MalformedElementException
true
if this propertybehavior is in the
"omit" form, otherwise, returns false
.
MalformedElementException
- if there is reason to believe that
this editor's underlying element is not well formedpublic void setIsKeepAllAlive(boolean isKeepAllAlive)
isKeepAllAlive
- a boolean indicating whether this
propertybehavior will be in the "keep all
alive" formpublic void setIsOmit(boolean isOmit)
isOmit
- a boolean indicating whether this propertybehavior will
be in the "omit" form
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |