AbstractReadTransactionRequest (controller-docs 7.0.1 API)

java.lang.Object

org.opendaylight.controller.cluster.access.concepts.Message<T,C>

org.opendaylight.controller.cluster.access.concepts.Request<TransactionIdentifier,T>

org.opendaylight.controller.cluster.access.commands.TransactionRequest<T>

org.opendaylight.controller.cluster.access.commands.AbstractReadTransactionRequest<T>

Type Parameters:: T - Message type

All Implemented Interfaces:: Serializable, Immutable

Direct Known Subclasses:: AbstractReadPathTransactionRequest, IncrementTransactionSequenceRequest

public abstract class AbstractReadTransactionRequest<T extends AbstractReadTransactionRequest<T>> extends TransactionRequest<T>

Abstract base class for TransactionRequests accessing transaction state without modifying it.

This class is visible outside of this package for the purpose of allowing common instanceof checks and simplified codepaths.

See Also:

Serialized Form

Method Summary

Modifier and Type

Method

Description

protected MoreObjects.ToStringHelper

addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)

Add attributes to the output of Message.toString().

protected abstract org.opendaylight.controller.cluster.access.commands.AbstractReadTransactionRequest.SerialForm<T>

externalizableProxy(ABIVersion version)

Instantiate a serialization proxy for this object for the target ABI version.

final boolean

isSnapshotOnly()

Methods inherited from class org.opendaylight.controller.cluster.access.commands.TransactionRequest
toRequestFailure

Methods inherited from class org.opendaylight.controller.cluster.access.concepts.Request
getReplyTo

Methods inherited from class org.opendaylight.controller.cluster.access.concepts.Message
cloneAsVersion, getSequence, getTarget, getVersion, toString, toVersion, writeReplace

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details
- isSnapshotOnly
  
  public final boolean isSnapshotOnly()
- addToStringAttributes
  
  protected MoreObjects.ToStringHelper addToStringAttributes(MoreObjects.ToStringHelper toStringHelper)
  
  Description copied from class: Message
  
  Add attributes to the output of Message.toString(). Subclasses wanting to contribute additional information should override this method. Any null attributes will be omitted from the output.
  
  Overrides:
  
  addToStringAttributes in class Request<TransactionIdentifier,T extends AbstractReadTransactionRequest<T>>
  
  Parameters:
  
  toStringHelper - a MoreObjects.ToStringHelper instance
  
  Returns:
  
  The MoreObjects.ToStringHelper passed in as argument
- externalizableProxy
  
  protected abstract org.opendaylight.controller.cluster.access.commands.AbstractReadTransactionRequest.SerialForm<T> externalizableProxy(ABIVersion version)
  
  Description copied from class: Message
  
  Instantiate a serialization proxy for this object for the target ABI version. Implementations should return different objects for incompatible ABIVersions. This method should never fail, as any compatibility checks should have been done by Message.cloneAsVersion(ABIVersion).
  
  Specified by:
  
  externalizableProxy in class TransactionRequest<T extends AbstractReadTransactionRequest<T>>
  
  Parameters:
  
  version - Requested ABI version
  
  Returns:
  
  Proxy for this object