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

Class UpdateValue.Response

java.lang.Object

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

Enclosing class:

UpdateValue

public static class UpdateValue.Response
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UpdateValue.Response.Init<T extends UpdateValue.Response.Init<T>>

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Location	getLocation() Returns the Location affected by the operation that resulted in this response.
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(Converter<T> converter, ConflictResolver<T> resolver) 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(Converter<T> converter) 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.
int	hashCode()
boolean	hasValues() Determine if this response contains any returned values.
String	toString()
boolean	wasUpdated() Determine if an update occurred.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

wasUpdated

public boolean wasUpdated()

Determine if an update occurred.

The supplied Update indicates if a modification was made. If no modification was made, no store operation is performed and this will return false.

Returns:

true if the supplied Update modified the retrieved object, false otherwise.

getLocation

public Location getLocation()

Returns the Location affected by the operation that resulted in this response.

Returns:

the affected Location

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

getValues

public <T> List<T> getValues(Converter<T> converter)

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 an object using the supplied Converter rather than one registered with the ConverterFactory.

Parameters:

converter - The converter to use.

Returns:

a list of values, converted to the supplied class.

See Also:

Converter

getValue

public <T> T getValue(Converter<T> converter,
                      ConflictResolver<T> resolver)
               throws UnresolvedConflictException

Get a single, resolved object from this response.

The values will be converted to objects using the supplied Converter rather than one registered with the ConverterFactory.

If there are multiple values present (siblings), they will then be resolved using the supplied ConflictResolver rather than one registered with the ConflictResolverFactory.

Parameters:

converter - The converter to use.

resolver - The conflict resolver to use.

Returns:

the single, resolved value.

Throws:

UnresolvedConflictException - if the resolver fails to resolve siblings.

See Also:

Converter, ConflictResolver

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object