WriteCollector.WriteRequest (org.epics.gpclient 1.0.1 API)

java.lang.Object
- org.epics.gpclient.WriteCollector.WriteRequest<T>

Type Parameters:

T - the type of data to be written

Enclosing class:

WriteCollector<T>
```
public static class WriteCollector.WriteRequest<T>
extends Object
```
A request to write a particular value to a channel.
To perform the write, use getValue() to take the value to write, and respond with either writeSuccessful() or writeFailed(java.lang.Exception).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`T`	`getValue()`	The value to be written.
`void`	`writeFailed(Exception writeError)`	Notify that the write was not completed or that it completed with an error.
`void`	`writeSuccessful()`	Notify that the write was successfully completed.

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

- Method Detail
  - getValue
```
public T getValue()
```
    The value to be written.
    
    Returns:
    
    the value to be written, can be null
  - writeSuccessful
```
public void writeSuccessful()
```
    Notify that the write was successfully completed.
  - writeFailed
```
public void writeFailed(Exception writeError)
```
    Notify that the write was not completed or that it completed with an error.
    Note that the exception is propagated to the user layer of the gpclient, therefore the error message should be meaningful.
    
    Parameters:
    
    writeError - the error associated with the response