jPOS 1.6.7 API Documentation

org.jpos.space
Class TSpace<K,V>

java.lang.Object
  extended by java.util.TimerTask
      extended by org.jpos.space.TSpace<K,V>
All Implemented Interfaces:
java.lang.Runnable, LocalSpace<K,V>, Space<K,V>, Loggeable

public class TSpace<K,V>
extends java.util.TimerTask
implements LocalSpace<K,V>, Loggeable

TSpace implementation

Since:
!.4.9
Version:
$Revision: 2858 $ $Date: 2010-01-05 07:49:19 -0800 (Tue, 05 Jan 2010) $
Author:
Alejandro Revilla

Field Summary
static long GCDELAY
           
 
Constructor Summary
TSpace()
           
 
Method Summary
 void addListener(java.lang.Object key, SpaceListener listener)
          add a SpaceListener associated with a given key
 void addListener(java.lang.Object key, SpaceListener listener, long timeout)
          add a SpaceListener associated with a given key for a given period of time.
 void dump(java.io.PrintStream p, java.lang.String indent)
           
 boolean existAny(K[] keys)
           
 boolean existAny(K[] keys, long timeout)
           
 void gc()
           
 java.util.Map getEntries()
          unstandard method (required for space replication) - use with care
 java.lang.String getKeysAsString()
           
 java.util.Set getKeySet()
           
 V in(java.lang.Object key)
          Take an entry from the space, waiting forever until one exists.
 V in(java.lang.Object key, long timeout)
          Take an entry from the space, waiting a limited amount of time until one exists.
 V inp(java.lang.Object key)
          In probe takes an entry from the space if one exists, return null otherwise.
 boolean isEmpty()
           
 void notifyListeners(java.lang.Object key, java.lang.Object value)
           
 void out(K key, V value)
          Write a new entry into the Space
 void out(K key, V value, long timeout)
          Write a new entry into the Space, with an timeout value
 void push(K key, V value)
          Write a new entry at the head of a queue.
 void push(K key, V value, long timeout)
          Write a new entry at the head of the queue with a timeout value
 void put(K key, V value)
          Write a single entry at the head of the queue discarding the other entries
 void put(K key, V value, long timeout)
          Write a single entry at the head of the queue discarding the other entries, with timeout.
 V rd(java.lang.Object key)
          Read an entry from the space, waiting forever until one exists.
 V rd(java.lang.Object key, long timeout)
          Read an entry from the space, waiting a limited amount of time until one exists.
 V rdp(java.lang.Object key)
          Read probe reads an entry from the space if one exists, return null otherwise.
 void removeListener(java.lang.Object key, SpaceListener listener)
          removes a SpaceListener associated with a given key
 void run()
           
 void setEntries(java.util.Map entries)
          unstandard method (required for space replication) - use with care
 int size(java.lang.Object key)
           
 
Methods inherited from class java.util.TimerTask
cancel, scheduledExecutionTime
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

GCDELAY

public static final long GCDELAY
See Also:
Constant Field Values
Constructor Detail

TSpace

public TSpace()
Method Detail

out

public void out(K key,
                V value)
Description copied from interface: Space
Write a new entry into the Space

Specified by:
out in interface Space<K,V>
Parameters:
key - Entry's key
value - Object value

out

public void out(K key,
                V value,
                long timeout)
Description copied from interface: Space
Write a new entry into the Space, with an timeout value

Specified by:
out in interface Space<K,V>
Parameters:
key - Entry's key
value - Object value
timeout - timeout value

rdp

public V rdp(java.lang.Object key)
Description copied from interface: Space
Read probe reads an entry from the space if one exists, return null otherwise.

Specified by:
rdp in interface Space<K,V>
Parameters:
key - Entry's key
Returns:
value or null

inp

public V inp(java.lang.Object key)
Description copied from interface: Space
In probe takes an entry from the space if one exists, return null otherwise.

Specified by:
inp in interface Space<K,V>
Parameters:
key - Entry's key
Returns:
value or null

in

public V in(java.lang.Object key)
Description copied from interface: Space
Take an entry from the space, waiting forever until one exists.

Specified by:
in in interface Space<K,V>
Parameters:
key - Entry's key
Returns:
value

in

public V in(java.lang.Object key,
            long timeout)
Description copied from interface: Space
Take an entry from the space, waiting a limited amount of time until one exists.

Specified by:
in in interface Space<K,V>
Parameters:
key - Entry's key
timeout - millis to wait
Returns:
value or null

rd

public V rd(java.lang.Object key)
Description copied from interface: Space
Read an entry from the space, waiting forever until one exists.

Specified by:
rd in interface Space<K,V>
Parameters:
key - Entry's key
Returns:
value

rd

public V rd(java.lang.Object key,
            long timeout)
Description copied from interface: Space
Read an entry from the space, waiting a limited amount of time until one exists.

Specified by:
rd in interface Space<K,V>
Parameters:
key - Entry's key
timeout - millis to wait
Returns:
value or null

run

public void run()
Specified by:
run in interface java.lang.Runnable
Specified by:
run in class java.util.TimerTask

gc

public void gc()

size

public int size(java.lang.Object key)
Specified by:
size in interface LocalSpace<K,V>
Returns:
number of entries in a given key

addListener

public void addListener(java.lang.Object key,
                        SpaceListener listener)
Description copied from interface: LocalSpace
add a SpaceListener associated with a given key

Specified by:
addListener in interface LocalSpace<K,V>
Parameters:
key - Entry's key
listener - a SpaceListener

addListener

public void addListener(java.lang.Object key,
                        SpaceListener listener,
                        long timeout)
Description copied from interface: LocalSpace
add a SpaceListener associated with a given key for a given period of time. Warning: not supported by all space implementations.

Specified by:
addListener in interface LocalSpace<K,V>
Parameters:
key - Entry's key
listener - a SpaceListener

removeListener

public void removeListener(java.lang.Object key,
                           SpaceListener listener)
Description copied from interface: LocalSpace
removes a SpaceListener associated with a given key

Specified by:
removeListener in interface LocalSpace<K,V>
Parameters:
key - Entry's key
listener - the SpaceListener

isEmpty

public boolean isEmpty()

getKeySet

public java.util.Set getKeySet()
Specified by:
getKeySet in interface LocalSpace<K,V>
Returns:
Set containing all keys in Space

getKeysAsString

public java.lang.String getKeysAsString()

dump

public void dump(java.io.PrintStream p,
                 java.lang.String indent)
Specified by:
dump in interface Loggeable

notifyListeners

public void notifyListeners(java.lang.Object key,
                            java.lang.Object value)

push

public void push(K key,
                 V value)
Description copied from interface: Space
Write a new entry at the head of a queue.

Specified by:
push in interface Space<K,V>
Parameters:
key - Entry's key
value - Object value

push

public void push(K key,
                 V value,
                 long timeout)
Description copied from interface: Space
Write a new entry at the head of the queue with a timeout value

Specified by:
push in interface Space<K,V>
Parameters:
key - Entry's key
value - Object value
timeout - timeout value

put

public void put(K key,
                V value)
Description copied from interface: Space
Write a single entry at the head of the queue discarding the other entries

Specified by:
put in interface Space<K,V>
Parameters:
key - Entry's key
value - Object value

put

public void put(K key,
                V value,
                long timeout)
Description copied from interface: Space
Write a single entry at the head of the queue discarding the other entries, with timeout.

Specified by:
put in interface Space<K,V>
Parameters:
key - Entry's key
value - Object value
timeout - timeout value

existAny

public boolean existAny(K[] keys)
Specified by:
existAny in interface Space<K,V>
Parameters:
keys - array of keys to check
Returns:
true if one or more keys are available in the space

existAny

public boolean existAny(K[] keys,
                        long timeout)
Specified by:
existAny in interface Space<K,V>
Parameters:
keys - array of keys to check
timeout - to wait for any of the entries to become available
Returns:
true if one or more keys are available in the space

getEntries

public java.util.Map getEntries()
unstandard method (required for space replication) - use with care

Returns:
underlying entry map

setEntries

public void setEntries(java.util.Map entries)
unstandard method (required for space replication) - use with care

Parameters:
entries - underlying entry map

jPOS.org