Namespace: OpenEdge.Core.Collections
Interface 
IStringStringMap
Parent classes:
Inherits: OpenEdge.Core.Collections.IMap

Copyright (c) 2014 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




Method Summary
Options Name Purpose
# Clear () /* Removes all mappings from this map (optional operation). */
Inherited from OpenEdge.Core.Collections.IMap
# LOGICAL ContainsAllKeys (ICollection) /* Returns true if this map maps one or more keys to the specified value.*/
Inherited from OpenEdge.Core.Collections.IMap
# LOGICAL ContainsAllValues (ICollection) /* Returns true if this map maps one or more keys to the specified value.*/
Inherited from OpenEdge.Core.Collections.IMap
# 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. */
Inherited from OpenEdge.Core.Collections.IMap
# 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 (Object) /* Returns true if this map maps one or more keys to the specified value.*/
Inherited from OpenEdge.Core.Collections.IMap
# 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 */
# Object Get (Object) /* Returns the value to which this map maps the specified key.*/
Inherited from OpenEdge.Core.Collections.IMap
# OpenEdge.Core.String Get (String) /** Returns the value to which this map maps the specified key.*/
# LOGICAL IsEmpty () /* Returns true if this map contains no key-value mappings.*/
Inherited from OpenEdge.Core.Collections.IMap
# LONGCHAR Put (character, longchar) /** Adds an entry to the mape @param character The key value @param longchar The value @return longchar The value added (may be previous value) */
# Object Put (Object, Object) /* Associates the specified value with the specified key in this map (optional operation).*/
Inherited from OpenEdge.Core.Collections.IMap
# OpenEdge.Core.String Put (String, String) /** Associates the specified value with the specified key in this map (optional operation).*/
# PutAll (IMap) /* Copies all of the mappings from the specified map to this map (optional operation).*/
Inherited from OpenEdge.Core.Collections.IMap
# 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 */
# Object Remove (Object) /* Removes the mapping for this key from this map if it is present (optional operation).*/
Inherited from OpenEdge.Core.Collections.IMap
# OpenEdge.Core.String 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.IMap

Property Summary
Options Name Purpose
# ISet EntrySet /* Returns a set view of the mappings contained in this map. -- Backed by map-- */
Inherited from OpenEdge.Core.Collections.IMap
# ISet KeySet /* Returns a set view of the keys contained in this map. -- Backed by map-- */
Inherited from OpenEdge.Core.Collections.IMap
# INTEGER Size /* Returns the number of key-value mappings in this map.*/
Inherited from OpenEdge.Core.Collections.IMap
# ICollection Values /* Returns a collection view of the values contained in this map. reflects changes to the map and vice-versa. Supports removal and removes the corresponding map entry from the map (Iterator.remove, Collection.remove, removeAll, retainAll and clear) . -- Backed by map-- */
Inherited from OpenEdge.Core.Collections.IMap


Method Detail
Top

PROTECTED Clear ()
Inherited from OpenEdge.Core.Collections.IMap
/* Removes all mappings from this map (optional operation).
Top

PROTECTED LOGICAL ContainsAllKeys (ICollection)
Inherited from OpenEdge.Core.Collections.IMap
/* Returns true if this map maps one or more keys to the specified value.
Parameters:
poKeys ICollection
Returns LOGICAL
Top

PROTECTED LOGICAL ContainsAllValues (ICollection)
Inherited from OpenEdge.Core.Collections.IMap
/* Returns true if this map maps one or more keys to the specified value.
Parameters:
poValues ICollection
Returns LOGICAL
Top

PROTECTED LOGICAL ContainsKey (character)
Purpose: Indicates whether a map exists for this key
Parameters:
pcKey CHARACTER
Returns LOGICAL
logical True if this key exists
Top

PROTECTED LOGICAL ContainsKey (Object)
Inherited from OpenEdge.Core.Collections.IMap
/* Returns true if this map contains a mapping for the specified key.
Parameters:
poKey Object
Returns LOGICAL
Top

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

PROTECTED 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

PROTECTED LOGICAL ContainsValue (Object)
Inherited from OpenEdge.Core.Collections.IMap
/* Returns true if this map maps one or more keys to the specified value.
Parameters:
poValue Object
Returns LOGICAL
Top

PROTECTED 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

PROTECTED LONGCHAR Get (character)
Purpose: Retrieves the value for a particular key
Parameters:
pcKey CHARACTER
Returns LONGCHAR
longchar The associated value
Top

PROTECTED Object Get (Object)
Inherited from OpenEdge.Core.Collections.IMap
/* Returns the value to which this map maps the specified key.
Parameters:
poKey Object
Returns Object
Top

PROTECTED 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

PROTECTED LOGICAL IsEmpty ()
Inherited from OpenEdge.Core.Collections.IMap
/* Returns true if this map contains no key-value mappings.
Returns LOGICAL
Top

PROTECTED LONGCHAR Put (character, longchar)
Purpose: Adds an entry to the mape
Parameters:
pcKey CHARACTER
pcValue LONGCHAR
Returns LONGCHAR
longchar The value added (may be previous value)
Top

PROTECTED Object Put (Object, Object)
Inherited from OpenEdge.Core.Collections.IMap
/* Associates the specified value with the specified key in this map (optional operation).
Parameters:
poKey Object
poValue Object
Returns Object
Top

PROTECTED 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

PROTECTED PutAll (IMap)
Inherited from OpenEdge.Core.Collections.IMap
/* Copies all of the mappings from the specified map to this map (optional operation).
Parameters:
poMap IMap
Top

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

PROTECTED LONGCHAR Remove (character)
Purpose: Removes the value for a particular key
Parameters:
pcKey CHARACTER
Returns LONGCHAR
longchar The associated value
Top

PROTECTED Object Remove (Object)
Inherited from OpenEdge.Core.Collections.IMap
/* Removes the mapping for this key from this map if it is present (optional operation).
Parameters:
poKey Object
Returns Object
Top

PROTECTED 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
Top

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


Property Detail
Top

PROTECTED ISet EntrySet
Inherited from OpenEdge.Core.Collections.IMap
/* Returns a set view of the mappings contained in this map.
-- Backed by map--
Returns ISet
Top

PROTECTED ISet KeySet
Inherited from OpenEdge.Core.Collections.IMap
/* Returns a set view of the keys contained in this map.
-- Backed by map--
Returns ISet
Top

PROTECTED INTEGER Size
Inherited from OpenEdge.Core.Collections.IMap
/* Returns the number of key-value mappings in this map.
Returns INTEGER
Top

PROTECTED ICollection Values
Inherited from OpenEdge.Core.Collections.IMap
/* Returns a collection view of the values contained in this map.
reflects changes to the map and vice-versa.
Supports removal and removes the corresponding map entry from the map
(Iterator.remove, Collection.remove, removeAll, retainAll and clear) .
-- Backed by map--
Returns ICollection


10.27.2015 12:36:22