org.agilewiki.jid.collection.vlenc.map

Interface JAMap<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>

All Superinterfaces:

_Jid, org.agilewiki.jactor.Actor, org.agilewiki.jactor.lpc.TargetActor

All Known Implementing Classes:

BMapJid, IntegerBMapJid, IntegerMapJid, LongBMapJid, LongMapJid, MapJid, StringBMapJid, StringMapJid

public interface JAMap<KEY_TYPE extends Comparable<KEY_TYPE>,VALUE_TYPE extends Jid>
extends _Jid

Holds a map.

Method Summary

Methods

Modifier and Type	Method and Description
MapEntry<KEY_TYPE,VALUE_TYPE>	getCeiling(KEY_TYPE key) Returns the Actor value with the smallest key >= the given key.
MapEntry<KEY_TYPE,VALUE_TYPE>	getFirst()
MapEntry<KEY_TYPE,VALUE_TYPE>	getHigher(KEY_TYPE key) Returns the Actor value with a greater key.
MapEntry<KEY_TYPE,VALUE_TYPE>	getLast()
VALUE_TYPE	kGet(KEY_TYPE key) Returns the Actor value associated with the key.
Boolean	kMake(KEY_TYPE key) Add a tuple to the map unless there is a tuple with a matching first element.
Boolean	kMakeBytes(KEY_TYPE key, byte[] bytes) Add a tuple to the map unless there is a tuple with a matching first element.
boolean	kRemove(KEY_TYPE key) Removes the item identified by the key.
void	kSetBytes(KEY_TYPE key, byte[] bytes)
int	size() Returns the size of the collection.

Methods inherited from interface org.agilewiki.jid._Jid

change, getSerializedLength, load, resolvePathname, save, setContainerJid

Methods inherited from interface org.agilewiki.jactor.lpc.TargetActor

setExceptionHandler

Methods inherited from interface org.agilewiki.jactor.Actor

acceptEvent, acceptRequest, getActorType, getAncestor, getFactory, getMailbox, getMatch, getParent, hasDataItem, setInitialBufferCapacity

Method Detail

size

int size()
         throws Exception

Returns the size of the collection.

Returns:

The size of the collection.

Throws:

Exception

kMake

Boolean kMake(KEY_TYPE key)
              throws Exception

Add a tuple to the map unless there is a tuple with a matching first element.

Parameters:

key - Used to match the first element of the tuples.

Returns:

True if a new tuple was created.

Throws:

Exception

kMakeBytes

Boolean kMakeBytes(KEY_TYPE key,
                 byte[] bytes)
                   throws Exception

Add a tuple to the map unless there is a tuple with a matching first element.

Parameters:

key - Used to match the first element of the tuples.

bytes - The serialized form of a JID of the appropriate type.

Returns:

True if a new tuple was created; otherwise the old value is unaltered.

Throws:

Exception

kGet

VALUE_TYPE kGet(KEY_TYPE key)
                            throws Exception

Returns the Actor value associated with the key.

Parameters:

key - The key.

Returns:

The actor assigned to the key, or null.

Throws:

Exception

getHigher

MapEntry<KEY_TYPE,VALUE_TYPE> getHigher(KEY_TYPE key)
                                                                                 throws Exception

Returns the Actor value with a greater key.

Parameters:

key - The key.

Returns:

The matching jid, or null.

Throws:

Exception

getCeiling

MapEntry<KEY_TYPE,VALUE_TYPE> getCeiling(KEY_TYPE key)
                                                                                  throws Exception

Returns the Actor value with the smallest key >= the given key.

Parameters:

key - The key.

Returns:

The matching jid, or null.

Throws:

Exception

kRemove

boolean kRemove(KEY_TYPE key)
                throws Exception

Removes the item identified by the key.

Parameters:

key - The key.

Returns:

True when the item was present and removed.

Throws:

Exception

getFirst

MapEntry<KEY_TYPE,VALUE_TYPE> getFirst()
                                                                                throws Exception

Throws:

Exception

getLast

MapEntry<KEY_TYPE,VALUE_TYPE> getLast()
                                                                               throws Exception

Throws:

Exception

kSetBytes

void kSetBytes(KEY_TYPE key,
             byte[] bytes)
               throws Exception

Throws:

Exception