swarm.collections
Interface MapIndex


public abstract interface MapIndex
extends KeyedCollectionIndexS, KeyedCollectionIndex

The index behavior for a Map.. The index behavior for a Map.


Method Summary
 Object getKey()
          The getKey message returns the key value associated with the current location of the index.
 Object setKey(Object aKey)
          The setKey: messages repositions the index to an entry having a key value that matches its argument.
 
Methods inherited from interface swarm.collections.Index
compare, findNext, findPrev, get, getCollection, getLoc, getOffset, next, prev, put, remove, setLoc, setOffset
 
Methods inherited from interface swarm.defobj.DefinedObject
describe, describeID, getDisplayName, getTypeName, getZone, perform, perform$with, perform$with$with, perform$with$with$with, respondsTo, setDisplayName, xfprint, xfprintid, xprint, xprintid
 
Methods inherited from interface swarm.defobj.Drop
drop
 

Method Detail

setKey

public Object setKey(Object aKey)
The setKey: messages repositions the index to an entry having a key value that matches its argument. If there is more than one entry matching this key value, the index is positioned to the first entry that matches.

getKey

public Object getKey()
The getKey message returns the key value associated with the current location of the index. It returns nil if the index is not currently positioned at a member.