Package org.alfresco.repo.virtual.ref

Class Protocol

java.lang.Object

org.alfresco.repo.virtual.ref.Protocol

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

NodeProtocol, VirtualProtocol

public class Protocol
extends java.lang.Object
implements java.io.Serializable

A Reference model element that defines the type of the referred artefact and the virtualization process that was applied when creating a reference.
Protocols define the semantics of all elements of a reference. Protocol implementations add syntactic processing methods.
The high level semantic functionality of a protocol is implemented with ProtocolMethods.

Author:

Bogdan Horje

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static Encoding	DEFAULT_ENCODING
java.lang.String	name

Constructor Summary

Constructors

Constructor	Description
Protocol(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
Reference	addParameter(Reference reference, Parameter parameter)
Reference	addParameter(Reference reference, Resource resource)
<R> R	dispatch(ProtocolMethod<R> method, Reference reference)	ProtocolMethod double-dispatch/visitor protocol type selector.
Parameter	getParameter(Reference reference, int index)
Reference	propagateNodeRefMutations(org.alfresco.service.cmr.repository.NodeRef mutatedNodeRef, Reference reference)	Protocol delegate of Reference.propagateNodeRefMutations(NodeRef)
Reference	replaceParameter(Reference reference, int index, java.lang.String stringParameter)
Reference	replaceParameter(Reference reference, int index, Parameter parameter)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

public final java.lang.String name

DEFAULT_ENCODING

protected static final Encoding DEFAULT_ENCODING

Constructor Detail

Protocol

public Protocol(java.lang.String name)

Method Detail

getParameter

public Parameter getParameter(Reference reference,
                              int index)

replaceParameter

public Reference replaceParameter(Reference reference,
                                  int index,
                                  java.lang.String stringParameter)

replaceParameter

public Reference replaceParameter(Reference reference,
                                  int index,
                                  Parameter parameter)

addParameter

public Reference addParameter(Reference reference,
                              Resource resource)

addParameter

public Reference addParameter(Reference reference,
                              Parameter parameter)

dispatch

public <R> R dispatch(ProtocolMethod<R> method,
                      Reference reference)
               throws ProtocolMethodException

ProtocolMethod double-dispatch/visitor protocol type selector. Subclasses should override this method to select the appropriate type bound method.
This particular implementation calls the default ProtocolMethod.execute(Protocol, Reference) default method implementation.

Parameters:

method -

reference -

Returns:

the value returned by the type bond method

Throws:

ProtocolMethodException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

propagateNodeRefMutations

public Reference propagateNodeRefMutations(org.alfresco.service.cmr.repository.NodeRef mutatedNodeRef,
                                           Reference reference)

Protocol delegate of Reference.propagateNodeRefMutations(NodeRef)

Parameters:

mutatedNodeRef -

reference -

Returns:

a mutated version of the given Reference corresponding to the given mutated node or the given Reference if no mutations are detected