com.basho.riak.client.api.commands.kv

Class FetchValue.Response

java.lang.Object

com.basho.riak.client.api.commands.kv.FetchValue.Response

Enclosing class:

FetchValue

public static class FetchValue.Response
extends Object

A response from Riak containing results from a FetchValue command.

The Response, unless marked not found or unchanged, will contain one or more objects returned from Riak (all siblings are returned if present).

Method Summary

Methods

Modifier and Type	Method and Description
int	getNumberOfValues() Return the number of values contained in this response.
<T> T	getValue(Class<T> clazz) Get a single, resolved object from this response.
<T> T	getValue(com.fasterxml.jackson.core.type.TypeReference<T> typeReference) Get a single, resolved object from this response.
List<RiakObject>	getValues() Get all the objects returned in this response.
<T> List<T>	getValues(Class<T> clazz) Get all the objects returned in this response.
<T> List<T>	getValues(com.fasterxml.jackson.core.type.TypeReference<T> typeReference) Get the objects returned in this response.
VClock	getVectorClock() Get the vector clock returned with this response.
boolean	hasValues() Determine if this response contains any returned values.
boolean	isNotFound() Determine if there was a value in Riak.
boolean	isUnchanged() Determine if the value is unchanged.

Methods inherited from class java.lang.Object

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

Method Detail

isNotFound

public boolean isNotFound()

Determine if there was a value in Riak.

If there was no value present at the supplied Location in Riak, this will be true.

Returns:

true if there was no value in Riak.

isUnchanged

public boolean isUnchanged()

Determine if the value is unchanged.

If the fetch request set FetchValue.Option.IF_MODIFIED this indicates if the value in Riak has been modified.

Returns:

true if the vector clock for the object in Riak matched the supplied vector clock, false otherwise.

hasValues

public boolean hasValues()

Determine if this response contains any returned values.

Returns:

true if values are present, false otherwise.

getNumberOfValues

public int getNumberOfValues()

Return the number of values contained in this response.

If siblings are present at the Location, all values are returned.

Returns:

the number of values in this response.

getValues

public List<RiakObject> getValues()

Get all the objects returned in this response.

If siblings were present in Riak for the object you were fetching, this method will return all of them to you.

Returns:

a list of values as RiakObjects

getVectorClock

public VClock getVectorClock()

Get the vector clock returned with this response.

When storing/retrieving core Java types (HashMap, ArrayList,String, etc) or non-annotated POJOs this method allows you to retrieve the vector clock.

Returns:

The vector clock or null if one is not present.

getValues

public <T> List<T> getValues(Class<T> clazz)

Get all the objects returned in this response.

If siblings were present in Riak for the object you were fetching, this method will return all of them to you.

The values will be converted to the supplied class using the Converter returned from the ConverterFactory. By default this will be the JSONConverter, or no conversion at all if you pass in RiakObject.class.

Parameters:

clazz - the class to be converted to

Returns:

a list of values, converted to the supplied class.

See Also:

ConverterFactory, Converter

getValue

public <T> T getValue(Class<T> clazz)
           throws UnresolvedConflictException

Get a single, resolved object from this response.

The values will be converted to the supplied class using the Converter returned from the ConverterFactory. By default this will be the JSONConverter, or no conversion at all if you pass in RiakObject.class. If there are multiple values present (siblings), they will then be resolved using the ConflictResolver returned by the ConflictResolverFactory.

Parameters:

clazz - the class to be converted to.

Returns:

the single, resolved value converted to the supplied class.

Throws:

UnresolvedConflictException

See Also:

ConverterFactory, Converter, ConflictResolverFactory, ConflictResolver

getValue

public <T> T getValue(com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
           throws UnresolvedConflictException

Get a single, resolved object from this response.

The values will be converted to the supplied class using the Converter returned from the ConverterFactory. By default this will be the JSONConverter, or no conversion at all if you pass in RiakObject.class. If there are multiple values present (siblings), they will then be resolved using the ConflictResolver returned by the ConflictResolverFactory.

This version should only be used if you're converting to a parameterized generic domain object. For example:

 TypeReference<MyPojo<String>> tr = new TypeReference<MyPojo<String>>(){};
 MyPojo<String> myPojo = response.getValue(tr);
 

Parameters:

typeReference - The TypeReference of the class to be converted to.

Returns:

the single, resolved value converted to the supplied class.

Throws:

UnresolvedConflictException

See Also:

ConverterFactory, Converter, ConflictResolverFactory, ConflictResolver

getValues

public <T> List<T> getValues(com.fasterxml.jackson.core.type.TypeReference<T> typeReference)

Get the objects returned in this response.

If siblings were present in Riak for the object you were fetching, this method will return all of them to you.

The values will be converted to the supplied class using the Converter returned from the ConverterFactory. By default this will be the JSONConverter, or no conversion at all if you pass in a TypeReference for RiakObject.class.

This version should only be used if you're converting to a parameterized generic domain object. For example:

 TypeReference<MyPojo<String>> tr = new TypeReference<MyPojo<String>>(){};
 List<MyPojo<String>> list = response.getValues(tr);
 

Parameters:

typeReference - the TypeReference for the class to be converted to

Returns:

a list of values, converted to the supplied class.

See Also:

ConverterFactory, Converter