org.apache.jackrabbit.webdav.version

Class OptionsInfo

java.lang.Object

org.apache.jackrabbit.webdav.version.OptionsInfo

All Implemented Interfaces:

XmlSerializable

public class OptionsInfo
extends Object
implements XmlSerializable

OptionsInfo represents the Xml request body, that may be present with a OPTIONS request.
The DAV:options element is specified to have the following form.

 <!ELEMENT options ANY>
 ANY value: A sequence of elements each at most once.
 

Note, that this is a simplified implementation of the very generic definition: We assume that the DAV:options element only contains empty child elements, such as e.g. DAV:version-history-collection-set or DAV:workspace-collection-set.

See Also:

DeltaVConstants.XML_VH_COLLECTION_SET, DeltaVConstants.XML_WSP_COLLECTION_SET, DeltaVConstants.XML_ACTIVITY_COLLECTION_SET

Constructor Summary

Constructors

Constructor and Description
OptionsInfo(String[] entriesLocalNames) Create a new OptionsInfo with the specified entries.

Method Summary

Modifier and Type	Method and Description
boolean	containsElement(String localName, Namespace namespace) Returns true if a child element with the given name and namespace is present.
static OptionsInfo	createFromXml(Element optionsElement) Build an OptionsInfo object from the root element present in the request body.
Element	toXml(Document document) Returns the xml representation of the implementing object as Element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OptionsInfo

public OptionsInfo(String[] entriesLocalNames)

Create a new OptionsInfo with the specified entries. Each entry will be converted to an empty Xml element when calling toXml. As namespace DeltaVConstants.NAMESPACE is used.

Parameters:

entriesLocalNames -

Method Detail

containsElement

public boolean containsElement(String localName,
                               Namespace namespace)

Returns true if a child element with the given name and namespace is present.

Parameters:

localName -

namespace -

Returns:

true if such a child element exists in the options element.

toXml

public Element toXml(Document document)

Description copied from interface: XmlSerializable

Returns the xml representation of the implementing object as Element. The given Document is used as factory and represents the owner document of the returned DOM element.

Specified by:

toXml in interface XmlSerializable

Parameters:

document -

Returns:

a w3c element representing this object

See Also:

XmlSerializable.toXml(Document)

createFromXml

public static OptionsInfo createFromXml(Element optionsElement)
                                 throws DavException

Build an OptionsInfo object from the root element present in the request body.

Parameters:

optionsElement -

Returns:

Throws:

DavException - if the optionsElement is null or not a DAV:options element.