Namespace: OpenEdge.Core.Collections
Type: Class StringKeyedMap
Parent Classes:
Inherits: Progress.Lang.Object
Implements: OpenEdge.Core.Collections.IStringKeyedMap


Copyright (c) 2014, 2020, 2022-2023 by Progress Software Corporation. All rights reserved.
File:StringKeyedMap
Purpose:A map containing OE.Core.String keys and P.L.Object values.
Author(s):pjudge
Created:Wed Dec 18 13:55:14 EST 2013
Notes:An implementation of OpenEdge.Core.Collections.IMap
which now uses the Progress.Collections.HashMap for
data storage.
NOTICE: This class is intended for backwards compatibility
with applications using the OpenEdge.Core.Collections though
for Map objects it is highly recommended to directly use the
new Progress.Collections.HashMap<K,V> class directly.
/* New for OE12.8: Changed from temp-table to the new HashMap object as the holder of the map data.



Method Summary
  Options Name Purpose
  Clear () /* Removes all mappings from this map (optional operation). */
  LOGICAL ContainsAllKeys (ICollection) /* Returns true if this map contains all of the keys in a collection. @param ICollection A collection of keys. Must be a valid object. @return logical TRUE if all the keys in the input collection are in this map */
  LOGICAL ContainsAllValues (ICollection) /* Returns true if this map maps one or more keys to the specified value. @param ICollection A collection of values @return logical TRUE if all of the values in the source collection are values in the map's Values */
  LOGICAL ContainsKey (character) /* Indicates whether a map exists for this key @param character The key for the map entry. May be unknown or blank. @return logical TRUE of the map contains an entry with the specified key; FALSE otherwise */
  LOGICAL ContainsKey (Object) /* Returns true if this map contains a mapping for the specified key. @param Object The key for the map entry. Must be valid and of type OE.Core.String @return logical TRUE if the map contains an entry with the specified key; FALSE otherwise */
  LOGICAL ContainsKey (String) /* Returns true if this map contains a mapping for the specified key. @param String The key for the map entry. Must be valid @return logical TRUE of the map contains an entry with the specified key; FALSE otherwise */
  LOGICAL ContainsValue (Object) /* Returns true if there's at least one value in the map that equals the input value. @param Object The value to find. May be null/unknown. @return logical TRUE if at least one value exists in the map; FALSE otherwise. */
  Progress.Lang.Object Get (character) /* Retrieves the value for a particular key @param character The key for the map entry. @return Object The associated value, or unknown if the entry does not exist */
  Progress.Lang.Object Get (Object) /* Retrieves the value for a particular key @param Object The key for the map entry. The value object must be valid and of type OpenEdge.Core.String @return Object The associated value, or unknown if the entry does not exist. If the value exists, it will be of type Progress.Lang.Object */
  Progress.Lang.Object Get (String) /* Retrieves the value for a particular key @param String The key for the map entry. The value object must be valid. @return Object The associated value, or unknown if the entry does not exist */
  LOGICAL IsEmpty () /* Returns true if this map contains no key-value mappings. @return logical TRUE if the map has no entries; FALSE otherwise */
  Progress.Lang.Object Put (character, Object) /* Adds a value and/or key to the map. @param character The key for the map entry. May be empty or unknown. Is unique in the map. @param Object The value for the key. May be empty or unknown. @return Object The previous value, or unknown if none. Unknown is a valid value too. */
  Progress.Lang.Object Put (Object, Object) /* Adds a value and/or key to the map. @param Object The key for the map entry. Must be a valid value and must be of type OpenEdge.Core.String, but may have an empty or unknown value. Is unique in the map. @param Object The value for the key. If it is a valid value, it must be of type OpenEdge.Core.String, but may have an empty or unknown value. @return Object The previous value, or unknown if none. If a valid value, will be of type Progress.Lang.Object. Unknown is a valid value too. */
  Progress.Lang.Object Put (String, Object) /* Adds a value and/or key to the map. @param String The key for the map entry. Must be a valid object, but may have an empty or unknown value. Is unique in the map. @param Object The value for the key. May be a valid String object. @return Object The previous value, or unknown if none. Unknown is a valid value too. */
  PutAll (IMap) /* Adds all entries from another map to this one (optional operation). @param IMap A valid map */
  PutAll (IStringKeyedMap) /* Adds all the values from an input map (optional operation). @param IStringKeyedMap A valid map */
  Progress.Lang.Object Remove (character) /* Removes the value for a particular key @param character The key for the map entry, as character primitive. @return Object The associated value, or unknown if there is no entry. */
  Progress.Lang.Object Remove (Object) /* Removes the value for a particular key @param Object The key for the map entry. Must be a valid object, and must be of type OpenEdge.Core.String @return Object The associated value (of type OpenEdge.Core.String), or unknown if there is no entry. */
  Progress.Lang.Object Remove (String) /* Removes the map entry for a particular key @param String The key for the map entry. Must be a valid object. @return Object The associated value, or unknown if there is no entry. */
  RemoveAll (ICollection) /* Removes the mappings for all key from this map if it is present (optional operation). @param ICollection A collection of keys to remove */

Constructor Summary
  Options Name Purpose
  StringKeyedMap () /* Default constructor */
  StringKeyedMap (IMap) /* Constructor. Populates the map with the contents of another map. @param IMap Contains entries to add to this map. Entries are just added to this map, and are not cloned/duplicated */

Property Summary
  Options Name Purpose
  OpenEdge.Core.Collections.ISet EntrySet
  OpenEdge.Core.Collections.ISet KeySet
  INTEGER Size
  OpenEdge.Core.Collections.ICollection Values


Method Detail
Top

Clear ()

/* Removes all mappings from this map (optional operation).
Top

LOGICAL ContainsAllKeys (ICollection)

/* Returns true if this map contains all of the keys in a collection.
Parameters:
pKeys OpenEdge.Core.Collections.ICollection
 
Returns LOGICAL
  logical TRUE if all the keys in the input collection are in this map
Top

LOGICAL ContainsAllValues (ICollection)

/* Returns true if this map maps one or more keys to the specified value.
Parameters:
pValues OpenEdge.Core.Collections.ICollection
 
Returns LOGICAL
  logical TRUE if all of the values in the source collection are values in the map's Values
Top

LOGICAL ContainsKey (character)

/* Indicates whether a map exists for this key
Parameters:
pcKey CHARACTER
 
Returns LOGICAL
  logical TRUE of the map contains an entry with the specified key; FALSE otherwise
Top

LOGICAL ContainsKey (Object)

/* Returns true if this map contains a mapping for the specified key.
Parameters:
pKey Progress.Lang.Object
 
Returns LOGICAL
  logical TRUE if the map contains an entry with the specified key; FALSE otherwise
Top

LOGICAL ContainsKey (String)

/* Returns true if this map contains a mapping for the specified key.
Parameters:
pKey OpenEdge.Core.String
 
Returns LOGICAL
  logical TRUE of the map contains an entry with the specified key; FALSE otherwise
Top

LOGICAL ContainsValue (Object)

/* Returns true if there's at least one value in the map that equals the input value.
Parameters:
pValue Progress.Lang.Object
 
Returns LOGICAL
  logical TRUE if at least one value exists in the map; FALSE otherwise.
Top

Progress.Lang.Object Get (character)

/* Retrieves the value for a particular key
Parameters:
pKey CHARACTER
 
Returns Progress.Lang.Object
  Object The associated value, or unknown if the entry does not exist
Top

Progress.Lang.Object Get (Object)

/* Retrieves the value for a particular key
Parameters:
pKey Progress.Lang.Object
 
Returns Progress.Lang.Object
  Object The associated value, or unknown if the entry does not exist. If the value exists, it will be of type Progress.Lang.Object
Top

Progress.Lang.Object Get (String)

/* Retrieves the value for a particular key
Parameters:
pKey OpenEdge.Core.String
 
Returns Progress.Lang.Object
  Object The associated value, or unknown if the entry does not exist
Top

LOGICAL IsEmpty ()

/* Returns true if this map contains no key-value mappings.
Returns LOGICAL
  logical TRUE if the map has no entries; FALSE otherwise
Top

Progress.Lang.Object Put (character, Object)

/* Adds a value and/or key to the map.
Parameters:
pKey CHARACTER
 
pValue Progress.Lang.Object
 
Returns Progress.Lang.Object
  Object The previous value, or unknown if none. Unknown is a valid value too.
Top

Progress.Lang.Object Put (Object, Object)

/* Adds a value and/or key to the map.
Parameters:
pKey Progress.Lang.Object
 
pValue Progress.Lang.Object
 
Returns Progress.Lang.Object
  Object The previous value, or unknown if none. If a valid value, will be of type Progress.Lang.Object. Unknown is a valid value too.
Top

Progress.Lang.Object Put (String, Object)

/* Adds a value and/or key to the map.
Parameters:
pKey OpenEdge.Core.String
 
pValue Progress.Lang.Object
 
Returns Progress.Lang.Object
  Object The previous value, or unknown if none. Unknown is a valid value too.
Top

PutAll (IMap)

/* Adds all entries from another map to this one (optional operation).
Parameters:
pMap OpenEdge.Core.Collections.IMap
 
Top

PutAll (IStringKeyedMap)

/* Adds all the values from an input map (optional operation).
Parameters:
pMap OpenEdge.Core.Collections.IStringKeyedMap
 
Top

Progress.Lang.Object Remove (character)

/* Removes the value for a particular key
Parameters:
pcKey CHARACTER
 
Returns Progress.Lang.Object
  Object The associated value, or unknown if there is no entry.
Top

Progress.Lang.Object Remove (Object)

/* Removes the value for a particular key
Parameters:
pKey Progress.Lang.Object
 
Returns Progress.Lang.Object
  Object The associated value (of type OpenEdge.Core.String), or unknown if there is no entry.
Top

Progress.Lang.Object Remove (String)

/* Removes the map entry for a particular key
Parameters:
pKey OpenEdge.Core.String
 
Returns Progress.Lang.Object
  Object The associated value, or unknown if there is no entry.
Top

RemoveAll (ICollection)

/* Removes the mappings for all key from this map if it is present (optional operation).
Parameters:
pKeys OpenEdge.Core.Collections.ICollection
 


Constructor Detail
Top

StringKeyedMap ()

/* Default constructor
Top

StringKeyedMap (IMap)

/* Constructor. Populates the map with the contents of another map.
Parameters:
pMap OpenEdge.Core.Collections.IMap
 


Property Detail
Top

OpenEdge.Core.Collections.ISet EntrySet

Returns OpenEdge.Core.Collections.ISet
 
Top

OpenEdge.Core.Collections.ISet KeySet

Returns OpenEdge.Core.Collections.ISet
 
Top

INTEGER Size

Returns INTEGER
 
Top

OpenEdge.Core.Collections.ICollection Values

Returns OpenEdge.Core.Collections.ICollection