Namespace: OpenEdge.Core.Collections
Type: Interface IStringStringMap
Parent Classes:
Inherits: OpenEdge.Core.Collections.IMap


Copyright (c) 2014, 2023 by Progress Software Corporation. All rights reserved.
File:IStringStringMap
Purpose:A typed String/String Map
Author(s):pjudge
Created:Wed Dec 18 13:58:44 EST 2013
Notes:* Also contains IMap methods using ABL primitives instead
of OpenEdge.Core.String
Purpose: Associates the specified value with the specified key in this map (optional operation).



Method Summary
  Options Name Purpose
  LOGICAL ContainsKey (character) /** Indicates whether a map exists for this key @param character the key value @return logical True if this key exists */
  LOGICAL ContainsKey (String) /** Returns true if this map contains a mapping for the specified key. */
  LOGICAL ContainsValue (character) /** Indicates whether there is at least one value represented by the parameter in the map. @param longchar The value @return logical True if there is at least one entry with this value */
  LOGICAL ContainsValue (String) /** Returns true if this map maps one or more keys to the specified value.*/
  LONGCHAR Get (character) /** Retrieves the value for a particular key @param character The key value @return longchar The associated value */
  OpenEdge.Core.String Get (String) /** Returns the value to which this map maps the specified key.*/
  LONGCHAR Put (character, longchar) /** Adds an entry to the map @param character The key value @param longchar The value @return longchar The value added (may be blank or unknown) */
  OpenEdge.Core.String Put (String, String) /** Associates the specified value with the specified key in this map (optional operation).*/
  PutAll (IStringStringMap) /** Adds all data from the input map into this map */
  LONGCHAR Remove (character) /** Removes the value for a particular key @param character The key value @return longchar The associated value */
  OpenEdge.Core.String Remove (String) /** Removes the mapping for this key from this map if it is present (optional operation).*/

Method Detail
Top

LOGICAL ContainsKey (character)

Purpose: Indicates whether a map exists for this key
Parameters:
pcKey CHARACTER
 
Returns LOGICAL
  logical True if this key exists
Top

LOGICAL ContainsKey (String)

Purpose: Returns true if this map contains a mapping for the specified key.
Parameters:
poKey OpenEdge.Core.String
 
Returns LOGICAL
 
Top

LOGICAL ContainsValue (character)

Purpose: Indicates whether there is at least one value represented
by the parameter in the map.
Parameters:
pcValue CHARACTER
 
Returns LOGICAL
  logical True if there is at least one entry with this value
Top

LOGICAL ContainsValue (String)

Purpose: Returns true if this map maps one or more keys to the specified value.
Parameters:
poValue OpenEdge.Core.String
 
Returns LOGICAL
 
Top

LONGCHAR Get (character)

Purpose: Retrieves the value for a particular key
Parameters:
pcKey CHARACTER
 
Returns LONGCHAR
  longchar The associated value
Top

OpenEdge.Core.String Get (String)

Purpose: Returns the value to which this map maps the specified key.
Parameters:
poKey OpenEdge.Core.String
 
Returns OpenEdge.Core.String
 
Top

LONGCHAR Put (character, longchar)

Purpose: Adds an entry to the map
Parameters:
pcKey CHARACTER
 
pcValue LONGCHAR
 
Returns LONGCHAR
  longchar The value added (may be blank or unknown)
Top

OpenEdge.Core.String Put (String, String)

Purpose: Associates the specified value with the specified key in this map (optional operation).
Parameters:
poKey OpenEdge.Core.String
 
poValue OpenEdge.Core.String
 
Returns OpenEdge.Core.String
 
Top

PutAll (IStringStringMap)

Purpose: Adds all data from the input map into this map
Parameters:
poMap OpenEdge.Core.Collections.IStringStringMap
 
Top

LONGCHAR Remove (character)

Purpose: Removes the value for a particular key
Parameters:
pcKey CHARACTER
 
Returns LONGCHAR
  longchar The associated value
Top

OpenEdge.Core.String Remove (String)

Purpose: Removes the mapping for this key from this map if it is present (optional operation).
Parameters:
poKey OpenEdge.Core.String
 
Returns OpenEdge.Core.String