Namespace: OpenEdge.Core.Collections
Class
StringKeyedMap
Parent classes:
Inherits: OpenEdge.Core.Collections.Map
Implements: OpenEdge.Core.Collections.IStringKeyedMap

Copyright (c) 2014 by Progress Software Corporation. All rights reserved.
File:StringStringMap
Purpose:A map containing String keys and String values.
Author(s):pjudge
Created:Wed Dec 18 13:55:14 EST 2013




Method Summary
Options Name Purpose
Clear () /* Empties the map's contents */
Inherited from OpenEdge.Core.Collections.Map
LOGICAL ContainsAllKeys (ICollection) /* Returns true if this map contains all of the keys passed in. @param ICollection The collection of keys @return logical TRUE if all of the keys in the input collection are in the map */
Inherited from OpenEdge.Core.Collections.Map
LOGICAL ContainsAllValues (ICollection) /* Returns true if this map contains all of the values passed in. @param ICollection The collection of values @return logical TRUE if all of the values in the input collection are in the map */
Inherited from OpenEdge.Core.Collections.Map
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 (Object) /* Returns true if this map contains a mapping for the specified key. */
Overrides OpenEdge.Core.Collections.Map:ContainsKey (Object)
LOGICAL ContainsKey (String) /* Returns true if this map contains a mapping for the specified key. */
LOGICAL ContainsValue (Object) /* Returns true if this map contains the value passed in. @param ICollection The value to check @return logical TRUE if the value is in the map */
Inherited from OpenEdge.Core.Collections.Map
LOGICAL Equals (Object) /* Returns true if the given object is also a map and the two Maps represent the same mappings. */
Inherited from OpenEdge.Core.Collections.Map
Progress.Lang.Object Get (character) /** Retrieves the value for a particular key @param character The key value @return longchar The associated value */
Progress.Lang.Object Get (Object) /* Returns a value for a given key in the Map @param Object The key fopr which to return a value. NULL/unknown if the key is not in the map @return Object The value represented by the key */
Inherited from OpenEdge.Core.Collections.Map
Progress.Lang.Object Get (Object) /* Returns the value to which this map maps the specified key.*/
Progress.Lang.Object Get (String) /* Returns the value to which this map maps the specified key.*/
LOGICAL IsEmpty () /* Indicates whether the map has any entries. @return logical TRUE if the map is empty (no entries) and false otherwise */
Inherited from OpenEdge.Core.Collections.Map
Progress.Lang.Object Put (character, Object) /** Adds an entry to the map @param character The key value @param Object The value @return Object The value added (may be previous value) */
Progress.Lang.Object Put (Object, Object) /* Add entry to the map, return old value of any. Note that return of unknown could also mean that the old mapped value was unknown... (check Size before and after) @param Object The key for this mapping @param Object The value for the mapping @return Object If a value is replaced, the previous value is returned, otherwise null */
Inherited from OpenEdge.Core.Collections.Map
Progress.Lang.Object Put (Object, Object)
Progress.Lang.Object Put (String, Object) /* Associates the specified value with the specified key in this map (optional operation).*/
PutAll (IStringKeyedMap)
PutAll (IMap)
Overrides OpenEdge.Core.Collections.Map:PutAll (IMap)
Progress.Lang.Object Remove (character) /** Removes the value for a particular key @param character The key value @return longchar The associated value */
Progress.Lang.Object Remove (Object) /* Removes an entry @param Object The key for the entry to remove @param Object the value associated with that key. May be null. Note that return of unknown could also mean that the old mapped value was unknown. */
Inherited from OpenEdge.Core.Collections.Map
Progress.Lang.Object Remove (Object) /* Removes the mapping for this key from this map if it is present (optional operation).*/
Progress.Lang.Object Remove (String) /* Removes the mapping for this key from this map if it is present (optional operation).*/
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 */
Inherited from OpenEdge.Core.Collections.Map

Constructor Summary
Options Name Purpose
StringKeyedMap ()
StringKeyedMap (IStringKeyedMap)

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


Method Detail
Top

PUBLIC Clear ()

Inherited from OpenEdge.Core.Collections.Map
/* Empties the map's contents
Top

PUBLIC LOGICAL ContainsAllKeys (ICollection)

Inherited from OpenEdge.Core.Collections.Map
/* Returns true if this map contains all of the keys passed in.
Parameters:
poKeys ICollection
Returns LOGICAL
logical TRUE if all of the keys in the input collection are in the map
Top

PUBLIC LOGICAL ContainsAllValues (ICollection)

Inherited from OpenEdge.Core.Collections.Map
/* Returns true if this map contains all of the values passed in.
Parameters:
poValues ICollection
Returns LOGICAL
logical TRUE if all of the values in the input collection are in the map
Top

PUBLIC LOGICAL ContainsKey (character)

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

PUBLIC LOGICAL ContainsKey (Object)

Overrides OpenEdge.Core.Collections.Map:ContainsKey (Object)
/* Returns true if this map contains a mapping for the specified key.
Parameters:
poKey Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC LOGICAL ContainsKey (String)

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

PUBLIC LOGICAL ContainsValue (Object)

Inherited from OpenEdge.Core.Collections.Map
/* Returns true if this map contains the value passed in.
Parameters:
poValue Progress.Lang.Object
Returns LOGICAL
logical TRUE if the value is in the map
Top

PUBLIC LOGICAL Equals (Object)

Inherited from OpenEdge.Core.Collections.Map
/* Returns true if the given object is also a map and the two Maps represent the same mappings.
Parameters:
o Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC Progress.Lang.Object Get (character)

Purpose: Retrieves the value for a particular key
Parameters:
pcKey CHARACTER
Returns Progress.Lang.Object
longchar The associated value
Top

PUBLIC Progress.Lang.Object Get (Object)

Inherited from OpenEdge.Core.Collections.Map
/* Returns a value for a given key in the Map
Parameters:
poKey Progress.Lang.Object
Returns Progress.Lang.Object
Object The value represented by the key
Top

PUBLIC Progress.Lang.Object Get (Object)

/* Returns the value to which this map maps the specified key.
Parameters:
poKey Progress.Lang.Object
Returns Progress.Lang.Object
Top

PUBLIC Progress.Lang.Object Get (String)

/* Returns the value to which this map maps the specified key.
Parameters:
poKey OpenEdge.Core.String
Returns Progress.Lang.Object
Top

PUBLIC LOGICAL IsEmpty ()

Inherited from OpenEdge.Core.Collections.Map
/* Indicates whether the map has any entries.
Returns LOGICAL
logical TRUE if the map is empty (no entries) and false otherwise
Top

PUBLIC Progress.Lang.Object Put (character, Object)

Purpose: Adds an entry to the map
Parameters:
pcKey CHARACTER
poValue Progress.Lang.Object
Returns Progress.Lang.Object
Object The value added (may be previous value)
Top

PUBLIC Progress.Lang.Object Put (Object, Object)

Inherited from OpenEdge.Core.Collections.Map
/* Add entry to the map, return old value of any. Note that return of unknown could
also mean that the old mapped value was unknown... (check Size before and after)
Parameters:
poKey Progress.Lang.Object
poValue Progress.Lang.Object
Returns Progress.Lang.Object
Object If a value is replaced, the previous value is returned, otherwise null
Top

PUBLIC Progress.Lang.Object Put (Object, Object)

Parameters:
poKey Progress.Lang.Object
poValue Progress.Lang.Object
Returns Progress.Lang.Object
Top

PUBLIC Progress.Lang.Object Put (String, Object)

/* Associates the specified value with the specified key in this map (optional operation).
Parameters:
poKey OpenEdge.Core.String
poValue Progress.Lang.Object
Returns Progress.Lang.Object
Top

PUBLIC PutAll (IStringKeyedMap)

Parameters:
poMap OpenEdge.Core.Collections.IStringKeyedMap
Top

PUBLIC PutAll (IMap)

Overrides OpenEdge.Core.Collections.Map:PutAll (IMap)
Parameters:
poMap OpenEdge.Core.Collections.IMap
Top

PUBLIC Progress.Lang.Object Remove (character)

Purpose: Removes the value for a particular key
Parameters:
pcKey CHARACTER
Returns Progress.Lang.Object
longchar The associated value
Top

PUBLIC Progress.Lang.Object Remove (Object)

Inherited from OpenEdge.Core.Collections.Map
/* Removes an entry
also mean that the old mapped value was unknown.
Parameters:
poKey Progress.Lang.Object
Returns Progress.Lang.Object
Top

PUBLIC Progress.Lang.Object Remove (Object)

/* Removes the mapping for this key from this map if it is present (optional operation).
Parameters:
poKey Progress.Lang.Object
Returns Progress.Lang.Object
Top

PUBLIC Progress.Lang.Object Remove (String)

/* Removes the mapping for this key from this map if it is present (optional operation).
Parameters:
poKey OpenEdge.Core.String
Returns Progress.Lang.Object
Top

PUBLIC RemoveAll (ICollection)

Inherited from OpenEdge.Core.Collections.Map
Purpose: Removes the mappings for all key from this map if it is present (optional operation).
Parameters:
poKeys ICollection


Constructor Detail
Top

PUBLIC StringKeyedMap ()

Top

PUBLIC StringKeyedMap (IStringKeyedMap)

Parameters:
poMap OpenEdge.Core.Collections.IStringKeyedMap


Property Detail
Top

PUBLIC ISet EntrySet

Inherited from OpenEdge.Core.Collections.Map
Returns ISet
Top

PUBLIC ISet KeySet

Inherited from OpenEdge.Core.Collections.Map
Returns ISet
Top

PUBLIC INTEGER Size

Inherited from OpenEdge.Core.Collections.Map
Returns INTEGER
Top

PUBLIC ICollection Values

Inherited from OpenEdge.Core.Collections.Map
Returns ICollection


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0