com.tinkerpop.gremlin.process.computer.util

Class ImmutableMemory

java.lang.Object

com.tinkerpop.gremlin.process.computer.util.ImmutableMemory

All Implemented Interfaces:

Memory, Memory.Admin

public final class ImmutableMemory
extends java.lang.Object
implements Memory.Admin

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.gremlin.process.computer.Memory

Memory.Admin, Memory.Exceptions

Constructor Summary

Constructors

Constructor and Description
ImmutableMemory(Memory baseMemory)

Method Summary

Modifier and Type	Method and Description
boolean	and(java.lang.String key, boolean bool) Logically AND the provided boolean value with the boolean value currently stored at the key.
<R> R	get(java.lang.String key) Get the value associated with the provided key.
int	getIteration() Get the current iteration number.
long	getRuntime() Get the amount of milliseconds the GraphComputer has been executing thus far.
long	incr(java.lang.String key, long delta) Add the provided delta value to the long value currently stored at the key.
void	incrIteration()
java.util.Set<java.lang.String>	keys() The set of keys currently associated with this memory.
boolean	or(java.lang.String key, boolean bool) Logically OR the provided boolean value with the boolean value currently stored at the key.
void	set(java.lang.String key, java.lang.Object value) Set the value of the provided key.
void	setIteration(int iteration)
void	setRuntime(long runtime)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tinkerpop.gremlin.process.computer.Memory.Admin

asImmutable

Methods inherited from interface com.tinkerpop.gremlin.process.computer.Memory

asMap, exists, isInitialIteration

Constructor Detail

ImmutableMemory

public ImmutableMemory(Memory baseMemory)

Method Detail

keys

public java.util.Set<java.lang.String> keys()

Description copied from interface: Memory

The set of keys currently associated with this memory.

Specified by:

keys in interface Memory

Returns:

the memory's key set.

get

public <R> R get(java.lang.String key)
          throws java.lang.IllegalArgumentException

Description copied from interface: Memory

Get the value associated with the provided key.

Specified by:

get in interface Memory

Type Parameters:

R - the type of the value

Parameters:

key - the key of the value

Returns:

the value

Throws:

java.lang.IllegalArgumentException - is thrown if the key does not exist

set

public void set(java.lang.String key,
                java.lang.Object value)

Description copied from interface: Memory

Set the value of the provided key. This is typically called in setup() and/or terminate() of the VertexProgram. If this is called during execute(), there is no guarantee as to the ultimately stored value as call order is indeterminate.

Specified by:

set in interface Memory

Parameters:

key - they key to set a value for

value - the value to set for the key

getIteration

public int getIteration()

Description copied from interface: Memory

Get the current iteration number.

Specified by:

getIteration in interface Memory

Returns:

the current iteration

getRuntime

public long getRuntime()

Description copied from interface: Memory

Get the amount of milliseconds the GraphComputer has been executing thus far.

Specified by:

getRuntime in interface Memory

Returns:

the total time in milliseconds

incr

public long incr(java.lang.String key,
                 long delta)

Description copied from interface: Memory

Add the provided delta value to the long value currently stored at the key.

Specified by:

incr in interface Memory

Parameters:

key - the key of the long value

delta - the adjusting amount (can be negative for decrement)

Returns:

the adjusted value (according to the previous iterations current value + delta)

and

public boolean and(java.lang.String key,
                   boolean bool)

Description copied from interface: Memory

Logically AND the provided boolean value with the boolean value currently stored at the key.

Specified by:

and in interface Memory

Parameters:

key - the key of the boolean value

bool - the boolean to AND

Returns:

the adjusted value (according to the previous iterations current value && bool)

or

public boolean or(java.lang.String key,
                  boolean bool)

Description copied from interface: Memory

Logically OR the provided boolean value with the boolean value currently stored at the key.

Specified by:

or in interface Memory

Parameters:

key - the key of the boolean value

bool - the boolean to OR

Returns:

the adjusted value (according to the previous iterations current value || bool)

incrIteration

public void incrIteration()

Specified by:

incrIteration in interface Memory.Admin

setIteration

public void setIteration(int iteration)

Specified by:

setIteration in interface Memory.Admin

setRuntime

public void setRuntime(long runtime)

Specified by:

setRuntime in interface Memory.Admin

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object