|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.jackrabbit.webdav.ordering.OrderPatch
public class OrderPatch
OrderPatch
represents the mandatory request body of an
ORDERPATCH request. RFC 3648 defines the following structure for it:
<!ELEMENT orderpatch (ordering-type?, order-member*) > <!ELEMENT order-member (segment, position) > <!ELEMENT position (first | last | before | after) > <!ELEMENT segment (#PCDATA) > <!ELEMENT first EMPTY > <!ELEMENT last EMPTY > <!ELEMENT before segment > <!ELEMENT after segment >
Nested Class Summary | |
---|---|
static class |
OrderPatch.Member
Internal class Member represents the 'Order-Member' children
elements of an 'OrderPatch' request body present in the ORDERPATCH request. |
Field Summary |
---|
Fields inherited from interface org.apache.jackrabbit.webdav.ordering.OrderingConstants |
---|
HEADER_ORDERING_TYPE, HEADER_POSITION, NAMESPACE, ORDERING_TYPE, ORDERING_TYPE_CUSTOM, ORDERING_TYPE_UNORDERED, SUPPORTED_LIVE_PROPERTY_SET, SUPPORTED_METHOD_SET, XML_AFTER, XML_BEFORE, XML_FIRST, XML_LAST, XML_ORDER_MEMBER, XML_ORDERING_TYPE, XML_ORDERPATCH, XML_POSITION, XML_SEGMENT |
Constructor Summary | |
---|---|
OrderPatch(String orderingType,
OrderPatch.Member instruction)
Create a new OrderPath object. |
|
OrderPatch(String orderingType,
OrderPatch.Member[] instructions)
Create a new OrderPath object. |
Method Summary | |
---|---|
static OrderPatch |
createFromXml(Element orderPatchElement)
Create a new OrderPath object. |
String |
getOrderingType()
Return the ordering type. |
OrderPatch.Member[] |
getOrderInstructions()
Return an array of OrderPatch.Member objects defining the re-ordering
instructions to be applied to the requested resource. |
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 |
---|
public OrderPatch(String orderingType, OrderPatch.Member instruction)
OrderPath
object.
orderingType
- instruction
- public OrderPatch(String orderingType, OrderPatch.Member[] instructions)
OrderPath
object.
orderingType
- instructions
- Method Detail |
---|
public String getOrderingType()
public OrderPatch.Member[] getOrderInstructions()
OrderPatch.Member
objects defining the re-ordering
instructions to be applied to the requested resource.
public Element toXml(Document document)
XmlSerializable
Element
. The given Document
is used
as factory and represents the owner document
of the returned DOM element.
toXml
in interface XmlSerializable
document
-
public static OrderPatch createFromXml(Element orderPatchElement) throws DavException
OrderPath
object.
orderPatchElement
-
IllegalArgumentException
- if the specified Xml element was not valid.
DavException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |