org.onosproject.store.service

Class WriteRequest

java.lang.Object

org.onosproject.store.service.WriteRequest

public class WriteRequest
extends Object

Database write request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WriteRequest.Type

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANY_VERSION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WriteRequest(WriteRequest.Type type, String tableName, String key, byte[] newValue, long previousVersion, byte[] oldValue)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	hashCode()
String	key()
byte[]	newValue()
byte[]	oldValue()
long	previousVersion()
static WriteRequest	put(String tableName, String key, byte[] newValue) Creates a write request, which will put the specified value to the table regardless of the previous value.
static WriteRequest	putIfAbsent(String tableName, String key, byte[] newValue) Creates a write request, which will put the specified value to the table if the previous value does not exist.
static WriteRequest	putIfValueMatches(String tableName, String key, byte[] oldValue, byte[] newValue) Creates a write request, which will put the specified value to the table if the previous value matches.
static WriteRequest	putIfVersionMatches(String tableName, String key, byte[] newValue, long previousVersion) Creates a write request, which will put the specified value to the table if the previous version matches.
static WriteRequest	remove(String tableName, String key) Creates a write request, which will remove the specified entry from the table regardless of the previous value.
static WriteRequest	removeIfValueMatches(String tableName, String key, byte[] oldValue) Creates a write request, which will remove the specified entry from the table if the previous value matches.
static WriteRequest	removeIfVersionMatches(String tableName, String key, long previousVersion) Creates a write request, which will remove the specified entry from the table if the previous version matches.
String	tableName()
String	toString()
WriteRequest.Type	type()

Methods inherited from class java.lang.Object

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

Field Detail

ANY_VERSION

public static final int ANY_VERSION

See Also:

Constant Field Values

Constructor Detail

WriteRequest

protected WriteRequest(WriteRequest.Type type,
                       String tableName,
                       String key,
                       byte[] newValue,
                       long previousVersion,
                       byte[] oldValue)

Method Detail

put

public static WriteRequest put(String tableName,
                               String key,
                               byte[] newValue)

Creates a write request, which will put the specified value to the table regardless of the previous value.

Parameters:

tableName - name of the table

key - key in the table

newValue - value to write, must not be null

Returns:

WriteRequest

putIfVersionMatches

public static WriteRequest putIfVersionMatches(String tableName,
                                               String key,
                                               byte[] newValue,
                                               long previousVersion)

Creates a write request, which will put the specified value to the table if the previous version matches.

Parameters:

tableName - name of the table

key - key in the table

newValue - value to write, must not be null

previousVersion - previous version expected

Returns:

WriteRequest

putIfValueMatches

public static WriteRequest putIfValueMatches(String tableName,
                                             String key,
                                             byte[] oldValue,
                                             byte[] newValue)

Creates a write request, which will put the specified value to the table if the previous value matches.

Parameters:

tableName - name of the table

key - key in the table

oldValue - previous value expected, must not be null

newValue - value to write, must not be null

Returns:

WriteRequest

putIfAbsent

public static WriteRequest putIfAbsent(String tableName,
                                       String key,
                                       byte[] newValue)

Creates a write request, which will put the specified value to the table if the previous value does not exist.

Parameters:

tableName - name of the table

key - key in the table

newValue - value to write, must not be null

Returns:

WriteRequest

remove

public static WriteRequest remove(String tableName,
                                  String key)

Creates a write request, which will remove the specified entry from the table regardless of the previous value.

Parameters:

tableName - name of the table

key - key in the table

Returns:

WriteRequest

removeIfVersionMatches

public static WriteRequest removeIfVersionMatches(String tableName,
                                                  String key,
                                                  long previousVersion)

Creates a write request, which will remove the specified entry from the table if the previous version matches.

Parameters:

tableName - name of the table

key - key in the table

previousVersion - previous version expected

Returns:

WriteRequest

removeIfValueMatches

public static WriteRequest removeIfValueMatches(String tableName,
                                                String key,
                                                byte[] oldValue)

Creates a write request, which will remove the specified entry from the table if the previous value matches.

Parameters:

tableName - name of the table

key - key in the table

oldValue - previous value expected, must not be null

Returns:

WriteRequest

tableName

public String tableName()

key

public String key()

type

public WriteRequest.Type type()

newValue

public byte[] newValue()

previousVersion

public long previousVersion()

oldValue

public byte[] oldValue()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object