io.lettuce.core.output

Class ComplexData

java.lang.Object

io.lettuce.core.output.ComplexData

Direct Known Subclasses:

SetComplexData

public abstract class ComplexData
extends Object

The base type of all complex data, collected by a ComplexOutput

Commands typically result in simple types, however some of the commands could return complex nested structures. In these cases, and with the help of a ComplexDataParser, the data gathered by the ComplexOutput could be parsed to a domain object.

An complex data object could only be an aggregate data type as per the RESP2 and RESP3 protocol definitions. Its contents, however, could be both the simple and aggregate data types.

For RESP2 the only possible aggregation is an array. RESP2 commands could also return sets (obviously, by simply making sure the elements of the array are unique) or maps (by sending the keys as odd elements and their values as even elements in the right order one after another.

For RESP3 all the three aggregate types are supported (and indicated with special characters when the result is returned by the server).

Aggregate data types could also be nested by using the storeObject(Object) call.

Implementations of this class override the getDynamicSet(), getDynamicList() and getDynamicMap() methods to return the data received in the server in a implementation of the Collections framework. If a given implementation could not do the conversion in a meaningful way an UnsupportedOperationException would be thrown.

Since:

6.5

Author:

Tihomir Mateev

See Also:

ComplexOutput, ArrayComplexData, SetComplexData, MapComplexData

Constructor Summary

Constructors

Constructor and Description
ComplexData()

Method Summary

Modifier and Type	Method and Description
List<Object>	getDynamicList() Returns the aggregate data in a List form.
Map<Object,Object>	getDynamicMap() Returns the aggregate data in a Map form.
Set<Object>	getDynamicSet() Returns the aggregate data in a Set form.
void	store(boolean value) Store a boolean value in the underlying data structure
void	store(double value) Store a double value in the underlying data structure
void	store(long value) Store a long value in the underlying data structure
void	store(String value)
abstract void	storeObject(Object value) Store an Object value in the underlying data structure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComplexData

public ComplexData()

Method Detail

store

public void store(long value)

Store a long value in the underlying data structure

Parameters:

value - the value to store

store

public void store(double value)

Store a double value in the underlying data structure

Parameters:

value - the value to store

store

public void store(boolean value)

Store a boolean value in the underlying data structure

Parameters:

value - the value to store

storeObject

public abstract void storeObject(Object value)

Store an Object value in the underlying data structure. This method should be used when nesting one instance of ComplexData inside another

Parameters:

value - the value to store

store

public void store(String value)

getDynamicList

public List<Object> getDynamicList()

Returns the aggregate data in a List form. If the underlying implementation could not convert the data structure to a List then an UnsupportedOperationException would be thrown.

Returns:

a List of Object values

getDynamicSet

public Set<Object> getDynamicSet()

Returns the aggregate data in a Set form. If the underlying implementation could not convert the data structure to a Set then an UnsupportedOperationException would be thrown.

Returns:

a Set of Object values

getDynamicMap

public Map<Object,Object> getDynamicMap()

Returns the aggregate data in a Map form. If the underlying implementation could not convert the data structure to a Map then an UnsupportedOperationException would be thrown.

Returns:

a Map of Object values