HiroMessage (hiro-client-java 0.5.1 API)

java.lang.Object
- co.arago.hiro.client.model.HiroJsonMap
- - co.arago.hiro.client.model.HiroMessage

All Implemented Interfaces:

JsonMessage, ToMap, java.io.Serializable

Direct Known Subclasses:

HiroItemListMessage, HiroTimeseriesListMessage.TimeseriesEntry, HiroVertexMessage, TokenResponse, VersionResponse
```
public class HiroMessage
extends HiroJsonMap
```
This contains a LinkedHashMap<String, Object> HiroJsonMap.fieldsMap (from HiroJsonMap for the generic incoming data.
This class is meant to parse HTTP responses and WebSocket messages received from HIRO.
```
 {
     "key": [any value]
     ...
 }
 
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected HiroError hiroError
- Fields inherited from class co.arago.hiro.client.model.HiroJsonMap
  fieldsMap

Constructor Summary

Constructors
Constructor Description

HiroMessage()
Default constructor for Jackson

HiroMessage(java.util.Map<java.lang.String,java.lang.Object> initialData)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`catchError(java.lang.String key, java.lang.Object value)`	If the key is "error", create `hiroError` from the value.
`HiroError`	`getError()`	Gets the received error in the response.
`boolean`	`isError()`	Checks for a received error.
`void`	`setField(java.lang.String key, java.lang.Object value)`	Set the field in `HiroJsonMap.fieldsMap` unless an error message is found via `catchError(String, Object)`.

Methods inherited from class co.arago.hiro.client.model.HiroJsonMap
addFields, getField, getMap, getUnmappedField, setFields, toMap

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

Methods inherited from interface co.arago.hiro.client.model.JsonMessage
toJsonString, toJsonStringNoNull, toPrettyJsonString, toPrettyJsonStringNoNull

- Field Detail
  - hiroError
```
protected HiroError hiroError
```
- Constructor Detail
  - HiroMessage
```
public HiroMessage()
```
    Default constructor for Jackson
  - HiroMessage
```
public HiroMessage(java.util.Map<java.lang.String,java.lang.Object> initialData)
```
    Constructor
    
    Parameters:
    
    initialData - Initial data for the fieldsMap.
- Method Detail
  - setField
```
public void setField(java.lang.String key,
                     java.lang.Object value)
```
    Set the field in HiroJsonMap.fieldsMap unless an error message is found via catchError(String, Object).
    
    Overrides:
    
    setField in class HiroJsonMap
    
    Parameters:
    
    key - The name of the field.
    
    value - The value of the field.
  - catchError
```
protected boolean catchError(java.lang.String key,
                             java.lang.Object value)
```
    If the key is "error", create hiroError from the value.
    
    Parameters:
    
    key - The name of the field.
    
    value - The value of the field.
    
    Returns:
    
    true if an error was found (key is "error"), false otherwise.
  - isError
```
public boolean isError()
```
    Checks for a received error.
    
    Returns:
    
    true or false
  - getError
```
public HiroError getError()
```
    Gets the received error in the response.
    
    Returns:
    
    The HiroErrorResponse or null if no error is present.