RESTClientProducer (adams-addons-pom 24.12.0-SNAPSHOT API)

Type Parameters:

T - the type of output data to use

All Superinterfaces:

adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.ErrorProvider, adams.core.option.OptionHandler, RESTClient

All Known Implementing Classes:

AbstractRESTClientSource, AbstractRESTClientTransformer, EchoClientSource, EchoClientTransformer
```
public interface RESTClientProducer<T>
extends RESTClient
```
Interface for classes that use webRESTservices.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addResponseDataListener(RESTClientProducerResponseDataListener l)`	Adds the listener for response data being received.
`Class[]`	`generates()`	Returns the classes that this client generates.
`T`	`getResponseData()`	Returns the response data, if any.
`boolean`	`hasResponseData()`	Checks whether there is any response data to be collected.
`void`	`removeResponseDataListener(RESTClientProducerResponseDataListener l)`	Removes the listener for response data being received.
`void`	`setResponseData(T value)`	Sets the response data.

Methods inherited from interface adams.core.CleanUpHandler
cleanUp

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.ErrorProvider
getLastError, hasLastError

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.flow.rest.RESTClient
getConnectionTimeout, getOwner, getReceiveTimeout, query, setConnectionTimeout, setOwner, setReceiveTimeout

- Method Detail
  - addResponseDataListener
```
void addResponseDataListener(RESTClientProducerResponseDataListener l)
```
    Adds the listener for response data being received.
    
    Parameters:
    
    l - the listener to add
  - removeResponseDataListener
```
void removeResponseDataListener(RESTClientProducerResponseDataListener l)
```
    Removes the listener for response data being received.
    
    Parameters:
    
    l - the listener to remove
  - generates
```
Class[] generates()
```
    Returns the classes that this client generates.
    
    Returns:
    
    the classes
  - hasResponseData
```
boolean hasResponseData()
```
    Checks whether there is any response data to be collected.
    
    Returns:
    
    true if data can be collected
    
    See Also:
    
    getResponseData()
  - setResponseData
```
void setResponseData(T value)
```
    Sets the response data.
    
    Parameters:
    
    value - the response data
  - getResponseData
```
T getResponseData()
```
    Returns the response data, if any.
    
    Returns:
    
    the response data