MapEnumerator.definitionString Method

Returns a description of the enumerator. For example, an enumerator for a map of integers to strings would return "[int -> str] enumerator".

Syntax

public str definitionString()

Run On

Called

Return Value

Type: str
A string that contains a description of the enumerator.

Examples

The following example creates a map and an enumerator for it, and then it prints out a definition of the enumerator.

{ 
    Map myMap = new Map(Types::Integer, Types::String); 
    MapEnumerator  enumerator; 
    int i; 
  
    // Add some elements to the map 
    myMap.insert(1, "Element one"); 
    myMap.insert(2, "Element two"); 
    myMap.insert(3, "Element three"); 
    myMap.insert(4, "Element Four"); 
  
    // Set the enumerator 
    enumerator = myMap.getEnumerator(); 
  
    print enumerator.definitionString(); 
    pause; 
}

See Also

MapEnumerator Class

MapEnumerator.toString Method