com.aerospike.client.large

Class LargeStack

java.lang.Object

com.aerospike.client.large.LargeStack

public class LargeStack
extends Object

Create and manage a stack within a single bin. A stack is last in/first out (LIFO).

Constructor Summary

Constructors

Constructor and Description
LargeStack(AerospikeClient client, WritePolicy policy, Key key, String binName, String createModule) Initialize large stack operator.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Delete bin containing the stack.
List<?>	filter(int peekCount, String filterModule, String filterName, Value... filterArgs) Select items from top of stack.
int	getCapacity() Return maximum number of entries for the stack.
Map<?,?>	getConfig() Return map of stack configuration parameters.
List<?>	peek(int peekCount) Select items from top of stack.
void	push(List<?> values) Push values onto stack.
void	push(Value... values) Push values onto stack.
void	push(Value value) Push value onto stack.
List<?>	scan() Return list of all objects on the stack.
void	setCapacity(int capacity) Set maximum number of entries for the stack.
int	size() Return size of stack.

Methods inherited from class java.lang.Object

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

Constructor Detail

LargeStack

public LargeStack(AerospikeClient client,
          WritePolicy policy,
          Key key,
          String binName,
          String createModule)

Initialize large stack operator.

Parameters:

client - client

policy - generic configuration parameters, pass in null for defaults

key - unique record identifier

binName - bin name

createModule - Lua function name that initializes list configuration parameters, pass null for default set

Method Detail

push

public void push(Value value)
          throws AerospikeException

Push value onto stack. If the stack does not exist, create it using specified userModule configuration.

Parameters:

value - value to push

Throws:

AerospikeException

push

public void push(Value... values)
          throws AerospikeException

Push values onto stack. If the stack does not exist, create it using specified userModule configuration.

Parameters:

values - values to push

Throws:

AerospikeException

push

public void push(List<?> values)
          throws AerospikeException

Push values onto stack. If the stack does not exist, create it using specified userModule configuration.

Parameters:

values - values to push

Throws:

AerospikeException

peek

public List<?> peek(int peekCount)
             throws AerospikeException

Select items from top of stack.

Parameters:

peekCount - number of items to select.

Returns:

list of items selected

Throws:

AerospikeException

scan

public List<?> scan()
             throws AerospikeException

Return list of all objects on the stack.

Throws:

AerospikeException

filter

public List<?> filter(int peekCount,
             String filterModule,
             String filterName,
             Value... filterArgs)
               throws AerospikeException

Select items from top of stack.

Parameters:

peekCount - number of items to select.

filterModule - Lua module name which contains filter function

filterName - Lua function name which applies filter to returned list

filterArgs - arguments to Lua function name

Returns:

list of items selected

Throws:

AerospikeException

destroy

public void destroy()
             throws AerospikeException

Delete bin containing the stack.

Throws:

AerospikeException

size

public int size()
         throws AerospikeException

Return size of stack.

Throws:

AerospikeException

getConfig

public Map<?,?> getConfig()
                   throws AerospikeException

Return map of stack configuration parameters.

Throws:

AerospikeException

setCapacity

public void setCapacity(int capacity)
                 throws AerospikeException

Set maximum number of entries for the stack.

Parameters:

capacity - max entries in set

Throws:

AerospikeException

getCapacity

public int getCapacity()
                throws AerospikeException

Return maximum number of entries for the stack.

Throws:

AerospikeException