Namespace: OpenEdge.Core.Collections
Type: Class StringCollection
Parent Classes:
Inherits: OpenEdge.Core.Collections.Collection
Implements: OpenEdge.Core.Collections.IStringCollection


Copyright (c) 2014 by Progress Software Corporation. All rights reserved.
File:StringCollection
Purpose:A collection of String and character/longchar objects
Author(s):pjudge
Created:Thu Feb 20 12:55:57 EST 2014



Method Summary
  Options Name Purpose
  LOGICAL Add (longchar) /** Appends the specified element to list if not already present @param longchar The element to add to the collection @return logical True if the operation succeeded. */
  LOGICAL Add (String) /** Add an object to the collection. @param {&ValueType} The object to add to the collection @return logical True if the operation succeeded. */
  LOGICAL AddAll (IStringCollection) /** Add a collection of objects to the collection. @param {&CollectionType} The collection to add to the collection @return logical True if the operation succeeded. */
  LOGICAL AddArray (longchar[]) /** [SLOW: O(n)] Adds an array of elements to the collection. @param longchar[] An array of elements to add to the collection @return logical True if the operation succeeded. */
  LOGICAL AddArray (String[]) /** Add an array of objects to the collection. @param {&CollectionType}[] The array to add to the collection @return logical True if the operation succeeded. */
  LOGICAL Contains (longchar) /** Check whether the colleciton contains at least one object that matches the passed in object. @param Object The object @return logical Returns true if the object is in the collection */
  LOGICAL Contains (String) /** Determine whether an object is in the collection. @param {&ValueType} The object to check in the collection @return logical True if the operation succeeded. */
  LOGICAL Remove (longchar) /** Removes the first occurrence in this list of the specified element @param Object The @return logical True if the operation succeded. */
  LOGICAL Remove (String) /** Remove an object from the collection. @param {&ValueType} The object to remove from the collection @return logical True if the operation succeeded. */
  LOGICAL RemoveAll (IStringCollection) /* Removes from this collection all the elements that are contained in the specified collection (optional operation). @param {&CollectionType} The collection of objects to remove. @return logical True if the operation succeeded. */
  LOGICAL RetainAll (IStringCollection) /* Retains only the elements in this list that are contained in the specified collection (optional operation). return true if the object changed @param {&CollectionType} The collection of objects to retain. @return logical True if the operation succeeded. */
  OpenEdge.Core.String ToStringArray () /* Returns the elements in this collection as an ABL array. @return {&ValueType}[] An ABL array of the objects in this collection */

Constructor Summary
  Options Name Purpose
  StringCollection ()
  StringCollection (IStringCollection)

Method Detail
Top

LOGICAL Add (longchar)

Purpose: Appends the specified element to list if not already present
Parameters:
pcElement LONGCHAR
 
Returns LOGICAL
  logical True if the operation succeeded.
Top

LOGICAL Add (String)

Purpose: Add an object to the collection.
Parameters:
newObject OpenEdge.Core.String
 
Returns LOGICAL
  logical True if the operation succeeded.
Top

LOGICAL AddAll (IStringCollection)

Purpose: Add a collection of objects to the collection.
Parameters:
poCollection OpenEdge.Core.Collections.IStringCollection
 
Returns LOGICAL
  logical True if the operation succeeded.
Top

LOGICAL AddArray (longchar[])

Purpose: [SLOW: O(n)] Adds an array of elements to the collection.
Parameters:
pcElements LONGCHAR
 
Returns LOGICAL
  logical True if the operation succeeded.
Top

LOGICAL AddArray (String[])

Purpose: Add an array of objects to the collection.
Parameters:
poArray OpenEdge.Core.String
 
Returns LOGICAL
  logical True if the operation succeeded.
Top

LOGICAL Contains (longchar)

Purpose: Check whether the colleciton contains at least one object
that matches the passed in object.
Parameters:
pcElement LONGCHAR
 
Returns LOGICAL
  logical Returns true if the object is in the collection
Top

LOGICAL Contains (String)

Purpose: Determine whether an object is in the collection.
Parameters:
checkObject OpenEdge.Core.String
 
Returns LOGICAL
  logical True if the operation succeeded.
Top

LOGICAL Remove (longchar)

Purpose: Removes the first occurrence in this list of the specified element
Parameters:
pcElement LONGCHAR
 
Returns LOGICAL
  logical True if the operation succeded.
Top

LOGICAL Remove (String)

Purpose: Remove an object from the collection.
Parameters:
oldObject OpenEdge.Core.String
 
Returns LOGICAL
  logical True if the operation succeeded.
Top

LOGICAL RemoveAll (IStringCollection)

/* Removes from this collection all the elements that are contained in the
specified collection (optional operation).
Parameters:
poCollection OpenEdge.Core.Collections.IStringCollection
 
Returns LOGICAL
  logical True if the operation succeeded.
Top

LOGICAL RetainAll (IStringCollection)

/* Retains only the elements in this list that are contained in the
specified collection (optional operation). return true if the object changed
Parameters:
poCollection OpenEdge.Core.Collections.IStringCollection
 
Returns LOGICAL
  logical True if the operation succeeded.
Top

OpenEdge.Core.String ToStringArray ()

/* Returns the elements in this collection as an ABL array.
Returns OpenEdge.Core.String
  {&ValueType}[] An ABL array of the objects in this collection


Constructor Detail
Top

StringCollection ()

Top

StringCollection (IStringCollection)

Parameters:
poCollection OpenEdge.Core.Collections.IStringCollection