AbstractReadPathTransactionRequest (controller-docs 3.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>
      - org.opendaylight.controller.cluster.access.commands.AbstractReadPathTransactionRequest<T>

Type Parameters:

T - Message type

All Implemented Interfaces:

Serializable, Immutable, MutationBehaviour<Immutable>

Direct Known Subclasses:

ExistsTransactionRequest, ReadTransactionRequest
```
@Beta
public abstract class AbstractReadPathTransactionRequest<T extends AbstractReadPathTransactionRequest<T>>
extends AbstractReadTransactionRequest<T>
```
Abstract base class for TransactionRequests accessing data as visible in the isolated context of a particular transaction. The path of the data being accessed is returned via getPath().
This class is visible outside of this package for the purpose of allowing common instanceof checks and simplified codepaths.

Author:

Robert Varga

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
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.AbstractReadTransactionRequestProxyV1<T>`	`externalizableProxy(ABIVersion version)`
`@NonNull YangInstanceIdentifier`	`getPath()`

Methods inherited from class org.opendaylight.controller.cluster.access.commands.AbstractReadTransactionRequest
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 Detail
  - getPath
```
public final @NonNull YangInstanceIdentifier getPath()
```
  - 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 AbstractReadTransactionRequest<T extends AbstractReadPathTransactionRequest<T>>
    
    Parameters:
    
    toStringHelper - a MoreObjects.ToStringHelper instance
    
    Returns:
    
    The MoreObjects.ToStringHelper passed in as argument
  - externalizableProxy
```
protected abstract org.opendaylight.controller.cluster.access.commands.AbstractReadTransactionRequestProxyV1<T> externalizableProxy(ABIVersion version)
```
    Specified by:
    
    externalizableProxy in class AbstractReadTransactionRequest<T extends AbstractReadPathTransactionRequest<T>>