Package co.arago.hiro.client.model

Class HiroItemListMessage<T extends HiroJsonMap>

java.lang.Object

co.arago.hiro.client.model.HiroJsonMap

co.arago.hiro.client.model.HiroMessage

co.arago.hiro.client.model.HiroItemListMessage<T>

All Implemented Interfaces:

JsonMessage, ToMap, java.io.Serializable

Direct Known Subclasses:

DefaultHiroItemListMessage, HiroTimeseriesListMessage, HiroVertexListMessage

public class HiroItemListMessage<T extends HiroJsonMap>
extends HiroMessage

Represents a HIRO list of items.

 {
     "items": [
        [JacksonJsonMap],
        ...
     ]
 }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<T>	items

Fields inherited from class co.arago.hiro.client.model.HiroMessage

hiroError

Fields inherited from class co.arago.hiro.client.model.HiroJsonMap

fieldsMap

Constructor Summary

Constructors

Constructor	Description
HiroItemListMessage()	Default constructor for Jackson
HiroItemListMessage(java.util.List<T> items)	Constructor with initial data

Method Summary

Modifier and Type	Method	Description
void	addItem(T item)	Append a single item
void	addItems(java.util.List<T> items)	Append multiple items
T	getFirst()	Return first item in list.
T	getItem(int index)	Return a single item.
java.util.List<T>	getItems()
T	getLast()	Return last item in list.
boolean	isEmpty()
void	setItems(java.util.List<T> items)	Set all items at once
int	size()

Methods inherited from class co.arago.hiro.client.model.HiroMessage

catchError, getError, isError, setField

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

items

protected final java.util.List<T extends HiroJsonMap> items

Constructor Detail

HiroItemListMessage

public HiroItemListMessage()

Default constructor for Jackson

HiroItemListMessage

public HiroItemListMessage(java.util.List<T> items)

Constructor with initial data

Parameters:

items - List with initial data

Method Detail

isEmpty

public boolean isEmpty()

Returns:

True if items is empty.

size

public int size()

Returns:

Number of items in items.

setItems

public void setItems(java.util.List<T> items)

Set all items at once

Parameters:

items - List of times

addItem

public void addItem(T item)

Append a single item

Parameters:

item - An item of type T

addItems

public void addItems(java.util.List<T> items)

Append multiple items

Parameters:

items - A list of items of type T

getItem

public T getItem(int index)

Return a single item.

Parameters:

index - Index of that item.

Returns:

Item or null if index is out of bounds.

getFirst

public T getFirst()

Return first item in list.

Returns:

Item or null items is empty.

getLast

public T getLast()

Return last item in list.

Returns:

Item or null items is empty.

getItems

public java.util.List<T> getItems()

Returns:

Reference to inner items.