Package io.pravega.client.tables.impl

Class TableSegmentEntry

java.lang.Object

io.pravega.client.tables.impl.TableSegmentEntry

public class TableSegmentEntry
extends java.lang.Object

Entry in a TableSegment.

Method Summary

Modifier and Type	Method	Description
@NonNull TableSegmentKey	getKey()	A TableSegmentKey representing the Key of this Table Entry.
io.netty.buffer.ByteBuf	getValue()	A ByteBuf representing the contents (value) of this Table Entry.
static TableSegmentEntry	notExists(byte[] key, byte[] value)	Creates a new TableSegmentEntry with a version that indicates the key must not exist.
static TableSegmentEntry	notExists(io.netty.buffer.ByteBuf key, io.netty.buffer.ByteBuf value)	Creates a new TableSegmentEntry with a version that indicates the key must not exist.
static TableSegmentEntry	notFound(io.netty.buffer.ByteBuf key)	Creates a new TableSegmentEntry for a response that indicates it does not exist.
static TableSegmentEntry	unversioned(byte[] key, byte[] value)	Creates a new TableSegmentEntry with no specific version.
static TableSegmentEntry	unversioned(io.netty.buffer.ByteBuf key, io.netty.buffer.ByteBuf value)	Creates a new TableSegmentEntry with no specific version.
static TableSegmentEntry	versioned(byte[] key, byte[] value, long version)	Creates a new TableSegmentEntry with a specific version.
static TableSegmentEntry	versioned(io.netty.buffer.ByteBuf key, io.netty.buffer.ByteBuf value, long version)	Creates a new TableSegmentEntry with a specific version.

Methods inherited from class java.lang.Object

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

Method Detail

unversioned

public static TableSegmentEntry unversioned(io.netty.buffer.ByteBuf key,
                                            io.netty.buffer.ByteBuf value)

Creates a new TableSegmentEntry with no specific version. When used with TableSegment.put(io.pravega.client.tables.impl.TableSegmentEntry), this TableSegmentEntry will be treated as an unconditional update.

Parameters:

key - A ByteBuf representing the contents of the Table Entry Key.

value - A ByteBuf representing the Table Entry Value.

Returns:

An unversioned TableSegmentEntry.

unversioned

public static TableSegmentEntry unversioned(byte[] key,
                                            byte[] value)

Creates a new TableSegmentEntry with no specific version. When used with TableSegment.put(io.pravega.client.tables.impl.TableSegmentEntry), this TableSegmentEntry will be treated as an unconditional update.

Parameters:

key - A byte array representing the contents of the Table Key. This will be wrapped in a ByteBuf.

value - A byte array representing the contents Table Entry Value. This will be wrapped in a ByteBuf.

Returns:

An unversioned TableSegmentEntry.

versioned

public static TableSegmentEntry versioned(io.netty.buffer.ByteBuf key,
                                          io.netty.buffer.ByteBuf value,
                                          long version)

Creates a new TableSegmentEntry with a specific version. When used with TableSegment.put(io.pravega.client.tables.impl.TableSegmentEntry), this TableSegmentEntry will be treated as a conditional update, conditioned on the key existing and having the specified version.

Parameters:

key - A ByteBuf representing the contents of the Table Entry Key.

value - A ByteBuf representing the Table Entry Value.

version - The version to set. Consider using unversioned(io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf), notExists(io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf) or notFound(io.netty.buffer.ByteBuf) for special-case versions.

Returns:

A versioned TableSegmentEntry.

versioned

public static TableSegmentEntry versioned(byte[] key,
                                          byte[] value,
                                          long version)

Creates a new TableSegmentEntry with a specific version. When used with TableSegment.put(io.pravega.client.tables.impl.TableSegmentEntry), this TableSegmentEntry will be treated as a conditional update, conditioned on the key existing and having the specified version.

Parameters:

key - A byte array representing the contents of the Table Key. This will be wrapped in a ByteBuf.

value - A byte array representing the contents Table Entry Value. This will be wrapped in a ByteBuf.

version - The version to set. Consider using unversioned(io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf), notExists(io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf) or notFound(io.netty.buffer.ByteBuf) for special-case versions.

Returns:

A versioned TableSegmentEntry.

notExists

public static TableSegmentEntry notExists(io.netty.buffer.ByteBuf key,
                                          io.netty.buffer.ByteBuf value)

Creates a new TableSegmentEntry with a version that indicates the key must not exist. When used with TableSegment.put(io.pravega.client.tables.impl.TableSegmentEntry), this TableSegmentEntry will be treated as a conditional update, conditioned on the key not existing.

Parameters:

key - A ByteBuf representing the contents of the Table Entry Key.

value - A ByteBuf representing the Table Entry Value.

Returns:

A TableSegmentEntry with a version set to TableSegmentKeyVersion.NOT_EXISTS.

notExists

public static TableSegmentEntry notExists(byte[] key,
                                          byte[] value)

Creates a new TableSegmentEntry with a version that indicates the key must not exist. When used with TableSegment.put(io.pravega.client.tables.impl.TableSegmentEntry), this TableSegmentEntry will be treated as a conditional update, conditioned on the key not existing.

Parameters:

key - A byte array representing the contents of the Table Key. This will be wrapped in a ByteBuf.

value - A byte array representing the contents Table Entry Value. This will be wrapped in a ByteBuf.

Returns:

A TableSegmentEntry with a version set to TableSegmentKeyVersion.NOT_EXISTS.

notFound

public static TableSegmentEntry notFound(io.netty.buffer.ByteBuf key)

Creates a new TableSegmentEntry for a response that indicates it does not exist. This is usually invoked internally from the TableSegment implementation to construct the response. This TableSegmentEntry should not be used as an argument for TableSegment.put(io.pravega.client.tables.impl.TableSegmentEntry) calls.

Parameters:

key - A ByteBuf representing the contents of the Table Entry Key.

Returns:

A TableSegmentEntry with a version set to TableSegmentKeyVersion.NOT_EXISTS and a getValue() set to null.

getKey

@NonNull
public @NonNull TableSegmentKey getKey()

A TableSegmentKey representing the Key of this Table Entry.

getValue

public io.netty.buffer.ByteBuf getValue()

A ByteBuf representing the contents (value) of this Table Entry. May be null if getKey() indicates that it does not exist.