org.mobicents.protocols.xcap.diff
Interface XcapDiffPatchBuilder<P,C,D,E,N>

Type Parameters:

P - the patch type, defines what is the concrete type of finalized XCAP DIFF patch

C - the component type, defines what is the concrete type of each patch component, to be aggregated in a XCAP DIFF patch

D - the document type, defines what is the concrete type of XML documents used

E - the element type, defines what is the concrete type of XML elements used

N - the xml patch ops node type, defines what is the concrete type of XML patch ops node params used by XmlPatchOperationsBuilder

public interface XcapDiffPatchBuilder<P,C,D,E,N>

Builds XCAP DIFF Patches, and exposes the patch component builders, which are used to build the patch components used in the final patch building.

Author:

baranowb, martins

Method Summary

P	buildPatch(java.lang.String xcapRoot, C[] components) Builds a XCAP DIFF patch, from the provided patch components, and the specified xcap root.
AttributePatchComponentBuilder<C>	getAttributePatchComponentBuilder() Retrieves the attribute patch component builder.
DocumentPatchComponentBuilder<C,D,E,N>	getDocumentPatchComponentBuilder() Retrieves the document patch component builder.
ElementPatchComponentBuilder<C,E>	getElementPatchComponentBuilder() Retrieves the element patch component builder.

Method Detail

buildPatch

P buildPatch(java.lang.String xcapRoot,
             C[] components)
             throws BuildPatchException

Builds a XCAP DIFF patch, from the provided patch components, and the specified xcap root.

Parameters:

xcapRoot - the patch xcap root

components - the patch components

Returns:

Throws:

BuildPatchException - if an exception occurred while building the patch, the concrete exception is the exception's cause.

getAttributePatchComponentBuilder

AttributePatchComponentBuilder<C> getAttributePatchComponentBuilder()

Retrieves the attribute patch component builder.

Returns:

getElementPatchComponentBuilder

ElementPatchComponentBuilder<C,E> getElementPatchComponentBuilder()

Retrieves the element patch component builder.

Returns:

getDocumentPatchComponentBuilder

DocumentPatchComponentBuilder<C,D,E,N> getDocumentPatchComponentBuilder()

Retrieves the document patch component builder.

Returns: