Package com.aerospike.mapper.tools.virtuallist

Class VirtualList<E>

java.lang.Object

com.aerospike.mapper.tools.virtuallist.BaseVirtualList<E>

com.aerospike.mapper.tools.virtuallist.VirtualList<E>

All Implemented Interfaces:

IVirtualList<E>

public class VirtualList<E>
extends BaseVirtualList<E>
implements IVirtualList<E>

Constructor Summary

Constructors

Constructor	Description
VirtualList(@NotNull IAeroMapper mapper, @NotNull Class<?> owningClazz, @NotNull Object key, @NotNull String binName, @NotNull Class<E> clazz)
VirtualList(@NotNull IAeroMapper mapper, @NotNull Object object, @NotNull String binName, @NotNull Class<E> clazz)

Method Summary

Modifier and Type	Method	Description
long	append(com.aerospike.client.policy.WritePolicy writePolicy, E element)	Append a new element at the end of the virtual list.
long	append(E element)	Append a new element at the end of the virtual list.
MultiOperation<E>	beginMulti(com.aerospike.client.policy.WritePolicy writePolicy)
MultiOperation<E>	beginMultiOperation()
VirtualList<E>	changeKey(Object newKey)
void	clear()	Remove all the items in the virtual list.
E	get(int index)	Get an element from the virtual list at a specific index.
E	get(com.aerospike.client.policy.Policy policy, int index)	Get an element from the virtual list at a specific index.
List<E>	getByIndexRange(int index, int count, ReturnType returnResultsOfType)	Get "count" items starting at specified index.
List<E>	getByIndexRange(int index, ReturnType returnResultsOfType)	Get items starting at specified index to the end of virtual list.
List<E>	getByIndexRange(com.aerospike.client.policy.WritePolicy writePolicy, int index, int count, ReturnType returnResultsOfType)	Get "count" items starting at specified index.
List<E>	getByIndexRange(com.aerospike.client.policy.WritePolicy writePolicy, int index, ReturnType returnResultsOfType)	Get items starting at specified index to the end of virtual list.
List<E>	getByKey(com.aerospike.client.policy.WritePolicy writePolicy, Object key, ReturnType returnResultsOfType)	Get items from the list matching the specified key.
List<E>	getByKey(Object key, ReturnType returnResultsOfType)	Get items from the list matching the specified key.
List<E>	getByKeyRange(com.aerospike.client.policy.WritePolicy writePolicy, Object startKey, Object endKey, ReturnType returnResultsOfType)	Get items from the list matching the specified key range.
List<E>	getByKeyRange(Object startKey, Object endKey, ReturnType returnResultsOfType)	Get items from the list matching the specified key range.
List<E>	getByRank(int rank, ReturnType returnResultsOfType)	Get items identified by rank.
List<E>	getByRank(com.aerospike.client.policy.WritePolicy writePolicy, int rank, ReturnType returnResultsOfType)	Get items identified by rank.
List<E>	getByRankRange(int rank, int count, ReturnType returnResultsOfType)	Get "count" items starting at specified rank to the last ranked item.
List<E>	getByRankRange(int rank, ReturnType returnResultsOfType)	Get items starting at specified rank to the last ranked item.
List<E>	getByRankRange(com.aerospike.client.policy.WritePolicy writePolicy, int rank, int count, ReturnType returnResultsOfType)	Get "count" items starting at specified rank to the last ranked item.
List<E>	getByRankRange(com.aerospike.client.policy.WritePolicy writePolicy, int rank, ReturnType returnResultsOfType)	Get items starting at specified rank to the last ranked item.
List<E>	getByValue(com.aerospike.client.policy.WritePolicy writePolicy, Object value, ReturnType returnResultsOfType)	Get items from the list matching the specified value.
List<E>	getByValue(Object value, ReturnType returnResultsOfType)	Get items from the list matching the specified value.
List<E>	getByValueList(com.aerospike.client.policy.WritePolicy writePolicy, List<Object> values, ReturnType returnResultsOfType)	Get items from the list matching the specified list of values.
List<E>	getByValueList(List<Object> values, ReturnType returnResultsOfType)	Get items from the list matching the specified list of values.
List<E>	getByValueRange(com.aerospike.client.policy.WritePolicy writePolicy, Object startValue, Object endValue, ReturnType returnResultsOfType)	Get items from the list matching the specified value.
List<E>	getByValueRange(Object startValue, Object endValue, ReturnType returnResultsOfType)	Get items from the list matching the specified value.
List<E>	getByValueRelativeRankRange(com.aerospike.client.policy.WritePolicy writePolicy, Object value, int rank, int count, ReturnType returnResultsOfType)	Get items nearest to value and greater by relative rank with a count limit.
List<E>	getByValueRelativeRankRange(com.aerospike.client.policy.WritePolicy writePolicy, Object value, int rank, ReturnType returnResultsOfType)	Get items nearest to value and greater by relative rank.
List<E>	getByValueRelativeRankRange(Object value, int rank, int count, ReturnType returnResultsOfType)	Get items nearest to value and greater by relative rank with a count limit.
List<E>	getByValueRelativeRankRange(Object value, int rank, ReturnType returnResultsOfType)	Get items nearest to value and greater by relative rank.
List<E>	removeByIndex(int index, ReturnType returnResultsOfType)	Remove item identified by index and returns removed data.
List<E>	removeByIndex(com.aerospike.client.policy.WritePolicy writePolicy, int index, ReturnType returnResultsOfType)	Remove item identified by index and returns removed data.
List<E>	removeByIndexRange(int index, int count, ReturnType returnResultsOfType)	Remove "count" items starting at specified index and returns removed data.
List<E>	removeByIndexRange(int index, ReturnType returnResultsOfType)	Remove items starting at specified index to the end of list and returns removed data.
List<E>	removeByIndexRange(com.aerospike.client.policy.WritePolicy writePolicy, int index, int count, ReturnType returnResultsOfType)	Remove "count" items starting at specified index and returns removed data.
List<E>	removeByIndexRange(com.aerospike.client.policy.WritePolicy writePolicy, int index, ReturnType returnResultsOfType)	Remove items starting at specified index to the end of list and returns removed data.
List<E>	removeByKey(com.aerospike.client.policy.WritePolicy writePolicy, Object key, ReturnType returnResultsOfType)	Remove items from the list matching the specified key.
List<E>	removeByKey(Object key, ReturnType returnResultsOfType)	Remove items from the list matching the specified key.
List<E>	removeByKeyRange(com.aerospike.client.policy.WritePolicy writePolicy, Object startKey, Object endKey, ReturnType returnResultsOfType)	Remove items from the list matching the specified key.
List<E>	removeByKeyRange(Object startKey, Object endKey, ReturnType returnResultsOfType)	Remove items from the list matching the specified key.
List<E>	removeByRank(int rank, ReturnType returnResultsOfType)	Remove item identified by rank and returns removed data.
List<E>	removeByRank(com.aerospike.client.policy.WritePolicy writePolicy, int rank, ReturnType returnResultsOfType)	Remove item identified by rank and returns removed data.
List<E>	removeByRankRange(int rank, int count, ReturnType returnResultsOfType)	Remove "count" items starting at specified rank and returns removed data.
List<E>	removeByRankRange(int rank, ReturnType returnResultsOfType)	Remove items starting at specified rank to the last ranked item and returns removed data.
List<E>	removeByRankRange(com.aerospike.client.policy.WritePolicy writePolicy, int rank, int count, ReturnType returnResultsOfType)	Remove "count" items starting at specified rank and returns removed data.
List<E>	removeByRankRange(com.aerospike.client.policy.WritePolicy writePolicy, int rank, ReturnType returnResultsOfType)	Remove items starting at specified rank to the last ranked item and returns removed data.
List<E>	removeByValue(com.aerospike.client.policy.WritePolicy writePolicy, Object value, ReturnType returnResultsOfType)	Remove items identified by value and returns the removed data.
List<E>	removeByValue(Object value, ReturnType returnResultsOfType)	Remove items identified by value and returns the removed data.
List<E>	removeByValueList(com.aerospike.client.policy.WritePolicy writePolicy, List<Object> values, ReturnType returnResultsOfType)	Remove items identified by list of values and returns the removed data.
List<E>	removeByValueList(List<Object> values, ReturnType returnResultsOfType)	Remove items identified by list of values and returns the removed data.
List<E>	removeByValueRange(com.aerospike.client.policy.WritePolicy writePolicy, Object startValue, Object endValue, ReturnType returnResultsOfType)	Remove items from the list matching the specified value.
List<E>	removeByValueRange(Object startValue, Object endValue, ReturnType returnResultsOfType)	Remove items from the list matching the specified value.
List<E>	removeByValueRelativeRankRange(com.aerospike.client.policy.WritePolicy writePolicy, Object value, int rank, int count, ReturnType returnResultsOfType)	Remove items nearest to value and greater by relative rank with a count limit.
List<E>	removeByValueRelativeRankRange(com.aerospike.client.policy.WritePolicy writePolicy, Object value, int rank, ReturnType returnResultsOfType)	Remove items nearest to value and greater by relative rank.
List<E>	removeByValueRelativeRankRange(Object value, int rank, int count, ReturnType returnResultsOfType)	Remove items nearest to value and greater by relative rank with a count limit.
List<E>	removeByValueRelativeRankRange(Object value, int rank, ReturnType returnResultsOfType)	Remove items nearest to value and greater by relative rank.
long	size(com.aerospike.client.policy.Policy policy)	Get the size of the virtual list (number of elements)

Methods inherited from class java.lang.Object

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

Constructor Details

VirtualList

public VirtualList(@NotNull
 @NotNull IAeroMapper mapper,
 @NotNull
 @NotNull Class<?> owningClazz,
 @NotNull
 @NotNull Object key,
 @NotNull
 @NotNull String binName,
 @NotNull
 @NotNull Class<E> clazz)

VirtualList

public VirtualList(@NotNull
 @NotNull IAeroMapper mapper,
 @NotNull
 @NotNull Object object,
 @NotNull
 @NotNull String binName,
 @NotNull
 @NotNull Class<E> clazz)

Method Details

changeKey

public VirtualList<E> changeKey(Object newKey)

beginMultiOperation

public MultiOperation<E> beginMultiOperation()

beginMulti

public MultiOperation<E> beginMulti(com.aerospike.client.policy.WritePolicy writePolicy)

getByValue

public List<E> getByValue(Object value,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items from the list matching the specified value.

Specified by:

getByValue in interface IVirtualList<E>

Parameters:

value - The value to get.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given value.

getByValue

public List<E> getByValue(com.aerospike.client.policy.WritePolicy writePolicy,
 Object value,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items from the list matching the specified value.

Specified by:

getByValue in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

value - The value to get.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given value.

getByValueRange

public List<E> getByValueRange(Object startValue,
 Object endValue,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items from the list matching the specified value. If the list is mapped to a MAP in Aerospike, the start value and end value will dictate the range of values to get, inclusive of the start, exclusive of the end.

If the list is mapped to a LIST in Aerospike however, the start and end range represent values to get from the list.

Specified by:

getByValueRange in interface IVirtualList<E>

Parameters:

startValue - Start value of the range to get.

endValue - End value of the range to get.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given value range.

getByValueRange

public List<E> getByValueRange(com.aerospike.client.policy.WritePolicy writePolicy,
 Object startValue,
 Object endValue,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items from the list matching the specified value. If the list is mapped to a MAP in Aerospike, the start value and end value will dictate the range of values to get, inclusive of the start, exclusive of the end.

If the list is mapped to a LIST in Aerospike however, the start and end range represent values to get from the list.

Specified by:

getByValueRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

startValue - Start value of the range to get.

endValue - End value of the range to get.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given value range.

getByValueList

public List<E> getByValueList(List<Object> values,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items from the list matching the specified list of values.

Specified by:

getByValueList in interface IVirtualList<E>

Parameters:

values - The list of values to get.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given list of values.

getByValueList

public List<E> getByValueList(com.aerospike.client.policy.WritePolicy writePolicy,
 List<Object> values,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items from the list matching the specified list of values.

Specified by:

getByValueList in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

values - The list of values to get.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given list of values.

getByValueRelativeRankRange

public List<E> getByValueRelativeRankRange(Object value,
 int rank,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items nearest to value and greater by relative rank.

Specified by:

getByValueRelativeRankRange in interface IVirtualList<E>

Parameters:

value - The value to base the relative rank range calculation on.

rank - The relative rank.

returnResultsOfType - Type to return.

Returns:

A list of records that matches the given value and rank.

getByValueRelativeRankRange

public List<E> getByValueRelativeRankRange(com.aerospike.client.policy.WritePolicy writePolicy,
 Object value,
 int rank,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items nearest to value and greater by relative rank.

Specified by:

getByValueRelativeRankRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

value - The value to base the relative rank range calculation on.

rank - The relative rank.

returnResultsOfType - Type to return.

Returns:

A list of records that matches the given value and rank.

getByValueRelativeRankRange

public List<E> getByValueRelativeRankRange(Object value,
 int rank,
 int count,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items nearest to value and greater by relative rank with a count limit.

Specified by:

getByValueRelativeRankRange in interface IVirtualList<E>

Parameters:

value - The value to base the relative rank range calculation on.

rank - The relative rank.

count - The count limit.

returnResultsOfType - Type to return.

Returns:

A list of records that matches the given value, rank and count.

getByValueRelativeRankRange

public List<E> getByValueRelativeRankRange(com.aerospike.client.policy.WritePolicy writePolicy,
 Object value,
 int rank,
 int count,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items nearest to value and greater by relative rank with a count limit.

Specified by:

getByValueRelativeRankRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

value - The value to base the relative rank range calculation on.

rank - The relative rank.

count - The count limit.

returnResultsOfType - Type to return.

Returns:

A list of records that matches the given value, rank and count.

getByIndexRange

public List<E> getByIndexRange(int index,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items starting at specified index to the end of virtual list.

Specified by:

getByIndexRange in interface IVirtualList<E>

Parameters:

index - The start index to get items from to the end of the virtual list.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given index.

getByIndexRange

public List<E> getByIndexRange(com.aerospike.client.policy.WritePolicy writePolicy,
 int index,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items starting at specified index to the end of virtual list.

Specified by:

getByIndexRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

index - The start index to get items from to the end of the virtual list.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given index.

getByIndexRange

public List<E> getByIndexRange(int index,
 int count,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get "count" items starting at specified index.

Specified by:

getByIndexRange in interface IVirtualList<E>

Parameters:

index - The start index to get the "count" items from.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given index and count.

getByIndexRange

public List<E> getByIndexRange(com.aerospike.client.policy.WritePolicy writePolicy,
 int index,
 int count,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get "count" items starting at specified index.

Specified by:

getByIndexRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

index - The start index to get the "count" items from.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given index and count.

getByRank

public List<E> getByRank(int rank,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items identified by rank.

Specified by:

getByRank in interface IVirtualList<E>

Parameters:

rank - The rank.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given rank.

getByRank

public List<E> getByRank(com.aerospike.client.policy.WritePolicy writePolicy,
 int rank,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items identified by rank.

Specified by:

getByRank in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

rank - The rank.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given rank.

getByRankRange

public List<E> getByRankRange(int rank,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items starting at specified rank to the last ranked item.

Specified by:

getByRankRange in interface IVirtualList<E>

Parameters:

rank - The starting rank.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given rank.

getByRankRange

public List<E> getByRankRange(com.aerospike.client.policy.WritePolicy writePolicy,
 int rank,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items starting at specified rank to the last ranked item.

Specified by:

getByRankRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

rank - The starting rank.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given rank.

getByRankRange

public List<E> getByRankRange(int rank,
 int count,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get "count" items starting at specified rank to the last ranked item.

Specified by:

getByRankRange in interface IVirtualList<E>

Parameters:

rank - The starting rank.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given rank and count.

getByRankRange

public List<E> getByRankRange(com.aerospike.client.policy.WritePolicy writePolicy,
 int rank,
 int count,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get "count" items starting at specified rank to the last ranked item.

Specified by:

getByRankRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

rank - The starting rank.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given rank and count.

getByKey

public List<E> getByKey(Object key,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items from the list matching the specified key. If the list is mapped to a MAP in Aerospike, It will get the matching key.

If the list is mapped to a LIST in Aerospike however, it will get the matching value.

Specified by:

getByKey in interface IVirtualList<E>

Parameters:

key - Key to get.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given key range.

getByKey

public List<E> getByKey(com.aerospike.client.policy.WritePolicy writePolicy,
 Object key,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items from the list matching the specified key. If the list is mapped to a MAP in Aerospike, It will get the matching key.

If the list is mapped to a LIST in Aerospike however, it will get the matching value.

Specified by:

getByKey in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

key - Key to get.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given key range.

getByKeyRange

public List<E> getByKeyRange(Object startKey,
 Object endKey,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items from the list matching the specified key range. If the list is mapped to a MAP in Aerospike, the start key and end key will dictate the range of keys to get, inclusive of the start, exclusive of the end.

If the list is mapped to a LIST in Aerospike however, the start and end range represent values to get from the list.

Specified by:

getByKeyRange in interface IVirtualList<E>

Parameters:

startKey - Start key of the range to get.

endKey - End key of the range to get.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given key range.

getByKeyRange

public List<E> getByKeyRange(com.aerospike.client.policy.WritePolicy writePolicy,
 Object startKey,
 Object endKey,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Get items from the list matching the specified key range. If the list is mapped to a MAP in Aerospike, the start key and end key will dictate the range of keys to get, inclusive of the start, exclusive of the end.

If the list is mapped to a LIST in Aerospike however, the start and end range represent values to get from the list.

Specified by:

getByKeyRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

startKey - Start key of the range to get.

endKey - End key of the range to get.

returnResultsOfType - Type to return.

Returns:

A list of the records which match the given key range.

removeByKey

public List<E> removeByKey(Object key,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items from the list matching the specified key. If the list is mapped to a MAP in Aerospike, the key will dictate the map key to be removed.

If the list is mapped to a LIST in Aerospike however, the given key will use as the value to remove from the list.

Specified by:

removeByKey in interface IVirtualList<E>

Parameters:

key - Key to remove.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByKey

public List<E> removeByKey(com.aerospike.client.policy.WritePolicy writePolicy,
 Object key,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items from the list matching the specified key. If the list is mapped to a MAP in Aerospike, the key will dictate the map key to be removed.

If the list is mapped to a LIST in Aerospike however, the given key will use as the value to remove from the list.

Specified by:

removeByKey in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

key - Key to remove.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByValue

public List<E> removeByValue(Object value,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items identified by value and returns the removed data.

Specified by:

removeByValue in interface IVirtualList<E>

Parameters:

value - The value to base the items to remove on.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByValue

public List<E> removeByValue(com.aerospike.client.policy.WritePolicy writePolicy,
 Object value,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items identified by value and returns the removed data.

Specified by:

removeByValue in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

value - The value to base the items to remove on.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByValueList

public List<E> removeByValueList(List<Object> values,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items identified by list of values and returns the removed data.

Specified by:

removeByValueList in interface IVirtualList<E>

Parameters:

values - The list of values to base the items to remove on.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByValueList

public List<E> removeByValueList(com.aerospike.client.policy.WritePolicy writePolicy,
 List<Object> values,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items identified by list of values and returns the removed data.

Specified by:

removeByValueList in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

values - The list of values to base the items to remove on.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByValueRange

public List<E> removeByValueRange(Object startValue,
 Object endValue,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items from the list matching the specified value. If the list is mapped to a MAP in Aerospike, the start value and end value will dictate the range of values to be removed, inclusive of the start, exclusive of the end.

If the list is mapped to a LIST in Aerospike however, the start and end range represent values to removed from the list.

Specified by:

removeByValueRange in interface IVirtualList<E>

Parameters:

startValue - Start value of the range to remove.

endValue - End value of the range to remove.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByValueRange

public List<E> removeByValueRange(com.aerospike.client.policy.WritePolicy writePolicy,
 Object startValue,
 Object endValue,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items from the list matching the specified value. If the list is mapped to a MAP in Aerospike, the start value and end value will dictate the range of values to be removed, inclusive of the start, exclusive of the end.

If the list is mapped to a LIST in Aerospike however, the start and end range represent values to be removed from the list.

Specified by:

removeByValueRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

startValue - Start value of the range to remove.

endValue - End value of the range to remove.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByValueRelativeRankRange

public List<E> removeByValueRelativeRankRange(Object value,
 int rank,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items nearest to value and greater by relative rank.

Specified by:

removeByValueRelativeRankRange in interface IVirtualList<E>

Parameters:

value - The value to base the items to remove on.

rank - The rank.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByValueRelativeRankRange

public List<E> removeByValueRelativeRankRange(com.aerospike.client.policy.WritePolicy writePolicy,
 Object value,
 int rank,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items nearest to value and greater by relative rank.

Specified by:

removeByValueRelativeRankRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

value - The value to base the items to remove on.

rank - The rank.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByValueRelativeRankRange

public List<E> removeByValueRelativeRankRange(Object value,
 int rank,
 int count,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items nearest to value and greater by relative rank with a count limit.

Specified by:

removeByValueRelativeRankRange in interface IVirtualList<E>

Parameters:

value - The value to base the items to remove on.

rank - The rank.

count - The count limit.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByValueRelativeRankRange

public List<E> removeByValueRelativeRankRange(com.aerospike.client.policy.WritePolicy writePolicy,
 Object value,
 int rank,
 int count,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items nearest to value and greater by relative rank with a count limit.

Specified by:

removeByValueRelativeRankRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

value - The value to base the items to remove on.

rank - The rank.

count - The count limit.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByIndex

public List<E> removeByIndex(int index,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove item identified by index and returns removed data.

Specified by:

removeByIndex in interface IVirtualList<E>

Parameters:

index - The index to remove the item from.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByIndex

public List<E> removeByIndex(com.aerospike.client.policy.WritePolicy writePolicy,
 int index,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove item identified by index and returns removed data.

Specified by:

removeByIndex in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

index - The index to remove the item from.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByIndexRange

public List<E> removeByIndexRange(int index,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items starting at specified index to the end of list and returns removed data.

Specified by:

removeByIndexRange in interface IVirtualList<E>

Parameters:

index - The start index to remove the item from.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByIndexRange

public List<E> removeByIndexRange(com.aerospike.client.policy.WritePolicy writePolicy,
 int index,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items starting at specified index to the end of list and returns removed data.

Specified by:

removeByIndexRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

index - The start index to remove the item from.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByIndexRange

public List<E> removeByIndexRange(int index,
 int count,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove "count" items starting at specified index and returns removed data.

Specified by:

removeByIndexRange in interface IVirtualList<E>

Parameters:

index - The start index to remove the item from.

count - The count limit.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByIndexRange

public List<E> removeByIndexRange(com.aerospike.client.policy.WritePolicy writePolicy,
 int index,
 int count,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove "count" items starting at specified index and returns removed data.

Specified by:

removeByIndexRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

index - The start index to remove the item from.

count - The count limit.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByRank

public List<E> removeByRank(int rank,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove item identified by rank and returns removed data.

Specified by:

removeByRank in interface IVirtualList<E>

Parameters:

rank - The rank.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByRank

public List<E> removeByRank(com.aerospike.client.policy.WritePolicy writePolicy,
 int rank,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove item identified by rank and returns removed data.

Specified by:

removeByRank in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

rank - The rank.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByRankRange

public List<E> removeByRankRange(int rank,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items starting at specified rank to the last ranked item and returns removed data.

Specified by:

removeByRankRange in interface IVirtualList<E>

Parameters:

rank - The starting rank.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByRankRange

public List<E> removeByRankRange(com.aerospike.client.policy.WritePolicy writePolicy,
 int rank,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items starting at specified rank to the last ranked item and returns removed data.

Specified by:

removeByRankRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

rank - The starting rank.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByRankRange

public List<E> removeByRankRange(int rank,
 int count,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove "count" items starting at specified rank and returns removed data.

Specified by:

removeByRankRange in interface IVirtualList<E>

Parameters:

rank - The starting rank.

count - The count limit.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByRankRange

public List<E> removeByRankRange(com.aerospike.client.policy.WritePolicy writePolicy,
 int rank,
 int count,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove "count" items starting at specified rank and returns removed data.

Specified by:

removeByRankRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

rank - The starting rank.

count - The count limit.

returnResultsOfType - Type to return.

Returns:

A list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByKeyRange

public List<E> removeByKeyRange(Object startKey,
 Object endKey,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items from the list matching the specified key. If the list is mapped to a MAP in Aerospike, the start key and end key will dictate the range of keys to be removed, inclusive of the start, exclusive of the end.

If the list is mapped to a LIST in Aerospike however, the start and end range represent values to be removed from the list.

Specified by:

removeByKeyRange in interface IVirtualList<E>

Parameters:

startKey - Start key of the range to remove.

endKey - End key of the range to remove.

returnResultsOfType - Type to return.

Returns:

The result of the method is a list of the records which have been removed from the database if returnResults is true, null otherwise.

removeByKeyRange

public List<E> removeByKeyRange(com.aerospike.client.policy.WritePolicy writePolicy,
 Object startKey,
 Object endKey,
 ReturnType returnResultsOfType)

Description copied from interface: IVirtualList

Remove items from the list matching the specified key. If the list is mapped to a MAP in Aerospike, the start key and end key will dictate the range of keys to be removed, inclusive of the start, exclusive of the end.

If the list is mapped to a LIST in Aerospike however, the start and end range represent values to be removed from the list.

Specified by:

removeByKeyRange in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

startKey - Start key of the range to remove.

endKey - End key of the range to remove.

returnResultsOfType - Type to return.

Returns:

The result of the method is a list of the records which have been removed from the database if returnResults is true, null otherwise.

append

public long append(E element)

Description copied from interface: IVirtualList

Append a new element at the end of the virtual list.

Specified by:

append in interface IVirtualList<E>

Parameters:

element - The given element to append.

Returns:

The list size.

append

public long append(com.aerospike.client.policy.WritePolicy writePolicy,
 E element)

Description copied from interface: IVirtualList

Append a new element at the end of the virtual list.

Specified by:

append in interface IVirtualList<E>

Parameters:

writePolicy - An Aerospike write policy to use for the operate() operation.

element - The given element to append.

Returns:

The size of the list. If the record is not found, this method returns -1.

get

public E get(int index)

Description copied from interface: IVirtualList

Get an element from the virtual list at a specific index.

Specified by:

get in interface IVirtualList<E>

Parameters:

index - The index to get the item from.

Returns:

The element to get from the virtual list.

get

public E get(com.aerospike.client.policy.Policy policy,
 int index)

Description copied from interface: IVirtualList

Get an element from the virtual list at a specific index.

Specified by:

get in interface IVirtualList<E>

Parameters:

policy - - The policy to use for the operate() operation.

index - The index to get the item from.

Returns:

The element to get from the virtual list.

size

public long size(com.aerospike.client.policy.Policy policy)

Description copied from interface: IVirtualList

Get the size of the virtual list (number of elements)

Specified by:

size in interface IVirtualList<E>

Parameters:

policy - - The policy to use for the operate() operation.

Returns:

The size of the list. If the record is not found, this method returns -1.

clear

public void clear()

Description copied from interface: IVirtualList

Remove all the items in the virtual list.

Specified by:

clear in interface IVirtualList<E>