com.aerospike.client.cdt

Class ListOperation

java.lang.Object

com.aerospike.client.cdt.ListOperation

public class ListOperation
extends Object

List bin operations. Create list operations used by client operate command. List operations support negative indexing. If the index is negative, the resolved index starts backwards from end of list.

Index/Range examples:

• Index 0: First item in list.
• Index 4: Fifth item in list.
• Index -1: Last item in list.
• Index -3: Third to last item in list.
• Index 1 Count 2: Second and third items in list.
• Index -3 Count 3: Last three items in list.
• Index -5 Count 4: Range between fifth to last item to second to last item inclusive.

If an index is out of bounds, a parameter error will be returned. If a range is partially out of bounds, the valid part of the range will be returned.

Constructor Summary

Constructors

Constructor and Description
ListOperation()

Method Summary

Methods

Modifier and Type	Method and Description
static Operation	append(String binName, Value value) Create list append operation.
static Operation	appendItems(String binName, List<Value> list) Create list append items operation.
static Operation	clear(String binName) Create list clear operation.
static Operation	get(String binName, int index) Create list get operation.
static Operation	getRange(String binName, int index) Create list get range operation.
static Operation	getRange(String binName, int index, int count) Create list get range operation.
static Operation	insert(String binName, int index, Value value) Create list insert operation.
static Operation	insertItems(String binName, int index, List<Value> list) Create list insert items operation.
static Operation	pop(String binName, int index) Create list pop operation.
static Operation	popRange(String binName, int index) Create list pop range operation.
static Operation	popRange(String binName, int index, int count) Create list pop range operation.
static Operation	remove(String binName, int index) Create list remove operation.
static Operation	removeRange(String binName, int index) Create list remove range operation.
static Operation	removeRange(String binName, int index, int count) Create list remove range operation.
static Operation	set(String binName, int index, Value value) Create list set operation.
static Operation	size(String binName) Create list size operation.
static Operation	trim(String binName, int index, int count) Create list trim operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListOperation

public ListOperation()

Method Detail

append

public static Operation append(String binName,
               Value value)

Create list append operation. Server appends value to end of list bin. Server returns list size.

appendItems

public static Operation appendItems(String binName,
                    List<Value> list)

Create list append items operation. Server appends each input list item to end of list bin. Server returns list size.

insert

public static Operation insert(String binName,
               int index,
               Value value)

Create list insert operation. Server inserts value to specified index of list bin. Server returns list size.

insertItems

public static Operation insertItems(String binName,
                    int index,
                    List<Value> list)

Create list insert items operation. Server inserts each input list item starting at specified index of list bin. Server returns list size.

pop

public static Operation pop(String binName,
            int index)

Create list pop operation. Server returns item at specified index and removes item from list bin.

popRange

public static Operation popRange(String binName,
                 int index,
                 int count)

Create list pop range operation. Server returns "count" items starting at specified index and removes items from list bin.

popRange

public static Operation popRange(String binName,
                 int index)

Create list pop range operation. Server returns items starting at specified index to the end of list and removes those items from list bin.

remove

public static Operation remove(String binName,
               int index)

Create list remove operation. Server removes item at specified index from list bin. Server returns number of items removed.

removeRange

public static Operation removeRange(String binName,
                    int index,
                    int count)

Create list remove range operation. Server removes "count" items starting at specified index from list bin. Server returns number of items removed.

removeRange

public static Operation removeRange(String binName,
                    int index)

Create list remove range operation. Server removes items starting at specified index to the end of list. Server returns number of items removed.

set

public static Operation set(String binName,
            int index,
            Value value)

Create list set operation. Server sets item value at specified index in list bin. Server does not return a result by default.

trim

public static Operation trim(String binName,
             int index,
             int count)

Create list trim operation. Server removes "count" items in list bin that do not fall into range specified by index and count range. If the range is out of bounds, then all items will be removed. Server returns list size after trim.

clear

public static Operation clear(String binName)

Create list clear operation. Server removes all items in list bin. Server does not return a result by default.

size

public static Operation size(String binName)

Create list size operation. Server returns size of list.

get

public static Operation get(String binName,
            int index)

Create list get operation. Server returns item at specified index in list bin.

getRange

public static Operation getRange(String binName,
                 int index,
                 int count)

Create list get range operation. Server returns "count" items starting at specified index in list bin.

getRange

public static Operation getRange(String binName,
                 int index)

Create list get range operation. Server returns items starting at index to the end of list.