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

Class DeleteValue

java.lang.Object

com.basho.riak.client.api.RiakCommand<R,I>

com.basho.riak.client.api.AsIsRiakCommand<Void,Location>

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

public final class DeleteValue
extends AsIsRiakCommand<Void,Location>

Command used to delete a value from Riak.

Deleting an object from Riak is a simple matter of supplying a Location and executing the operation.

Note that this operation returns a Void type upon success. Any failure will be thrown as an exception when calling DeleteValue synchronously or when calling the future's get methods.

 Namespace ns = new Namespace("my_type", "my_bucket");
 Location loc = new Location(ns, "my_key");
 DeleteValue dv = new DeleteValue.Builder(loc).build();
 client.execute(dv);

All operations can called async as well.

 ...
 RiakFuture<Void, Location> future = client.executeAsync(dv);
 ...
 future.await();
 if (future.isSuccess())
 {
     ...
 }

Since:

2.0

Author:

Dave Rusek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeleteValue.Builder Used to construct a DeleteValue command.
static class	DeleteValue.Option<T>

Constructor Summary

Constructors

Constructor and Description
DeleteValue(DeleteValue.Builder builder)

Method Summary

Modifier and Type	Method and Description
protected DeleteOperation	buildCoreOperation()
boolean	equals(Object obj)
protected RiakFuture<Void,Location>	executeAsync(RiakCluster cluster) To ensure that this method is accessible by MultiDelete.executeBaseCommandAsync(DeleteValue, RiakCluster) it MUST be overrode.
int	hashCode()
String	toString()

Methods inherited from class com.basho.riak.client.api.RiakCommand

execute, execute

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteValue

public DeleteValue(DeleteValue.Builder builder)

Method Detail

executeAsync

protected RiakFuture<Void,Location> executeAsync(RiakCluster cluster)

To ensure that this method is accessible by MultiDelete.executeBaseCommandAsync(DeleteValue, RiakCluster) it MUST be overrode.

Overrides:

executeAsync in class AsIsRiakCommand<Void,Location>

buildCoreOperation

protected DeleteOperation buildCoreOperation()

Specified by:

buildCoreOperation in class AsIsRiakCommand<Void,Location>

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