Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.protocol
Class AbstractReferenceBuilder

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.AbstractReferenceBuilder
All Implemented Interfaces:
ReferenceBuilder
Direct Known Subclasses:
IntReferenceBuilder

public abstract class AbstractReferenceBuilder
extends java.lang.Object
implements ReferenceBuilder


Field Summary
protected  java.lang.Object syncRoot
           
 
Constructor Summary
protected AbstractReferenceBuilder()
           
protected AbstractReferenceBuilder(java.lang.Object syncRoot)
           
 
Method Summary
abstract  java.lang.Object createReference()
          Creates next reference.
 java.lang.Object retreiveReference(Message message)
          Looks for reference in the message.
 java.lang.Object updateReference(Message message)
          Updates message's reference with created one.
 void updateReference(Message message, java.lang.Object reference)
          Updates message reference with the one supplied.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

syncRoot

protected final java.lang.Object syncRoot
Constructor Detail

AbstractReferenceBuilder

protected AbstractReferenceBuilder()

AbstractReferenceBuilder

protected AbstractReferenceBuilder(java.lang.Object syncRoot)
Method Detail

retreiveReference

public java.lang.Object retreiveReference(Message message)
Description copied from interface: ReferenceBuilder
Looks for reference in the message. Please note that usually channel will update reference if there is no one in message. This method should return null in cases when reference is set to the value that indicate absence of reference (e.g. 0 (zero) for integer).

Specified by:
retreiveReference in interface ReferenceBuilder
Parameters:
message - message to look for reference
Returns:
reference or null if no reference in the message

updateReference

public void updateReference(Message message,
                            java.lang.Object reference)
Description copied from interface: ReferenceBuilder
Updates message reference with the one supplied. Whether the reference will be overridden (if exists) is implementation specific.

Specified by:
updateReference in interface ReferenceBuilder
Parameters:
message - message to update reference in
reference - new reference

updateReference

public java.lang.Object updateReference(Message message)
Description copied from interface: ReferenceBuilder
Updates message's reference with created one. Whether the reference will be overridden (if exists) is implementation specific. In any case the reference returned should be the one message has after this method completed.

Specified by:
updateReference in interface ReferenceBuilder
Parameters:
message - message to update reference in
Returns:
message's reference

createReference

public abstract java.lang.Object createReference()
Description copied from interface: ReferenceBuilder
Creates next reference.

Specified by:
createReference in interface ReferenceBuilder
Returns:
reference

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.