Documentation Set for Swarm 2.2
Prev | Reference II. Collections Library | Next

# MapIndex

## Name

MapIndex -- The index behavior for a Map.

## Description

The index behavior for a Map.

## Protocols adopted by MapIndex

KeyedCollectionIndex RETURNABLE

## Methods

### Phase: Using

- - get: (id *)key
  Return the current item and it's key.

- - prev: (id *)key
  Return the previous item and it's key.

- - next: (id *)key
  Return the next item and it's key.

- - (unsigned long)getKeyValue
  The getKeyValue message returns the integer value associated with the current location of the index. It is exactly like getKey, except the value is returned as an integer. (A common application of this method is to get a Schedule time value associated with an Action in Java.)

- - 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.

- - setKey: 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.

Prev | Home | Next
Map | Up | MemberBlock