Namespace: OpenEdge.Core.Collections
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 (Object)
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
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 (ICollection)
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
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 (Object[])
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
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. */
Clear ()
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Object Clone () /* Deep clone. or rather deep enough since we don't know what the elements' Clone() operations do, so this may end up being a memberwise clone */
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
CloneElements (ICollection)
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
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 (Object)
Overrides OpenEdge.Core.Collections.Collection:Contains (Object)
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 ContainsAll (ICollection)
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
LOGICAL Equals (Object) /* Two Collections are defined to be equal if they are the same size and all of the elements in this collection are in the to-compare collection @param P.L.Object @return logical TRUE if the collections are equal. FALSE otherwise */
Inherited from OpenEdge.Core.Collections.Collection
FindBufferUseObject (Object) /* override this in subclass - used by remove(obj) and others */
Overrides OpenEdge.Core.Collections.Collection:FindBufferUseObject (Object)
FindBufferUseObject (Object, buffer)
Inherited from OpenEdge.Core.Collections.Collection
LOGICAL IsEmpty ()
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
IIterator Iterator () /* Returns a new IIterator over the collection. */
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
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 (Object)
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
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 (ICollection)
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
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. */
Resize () /** Recalculates the Size of this collections. Used particularly by Lists since there are operations like Remove() that are index-based and not item-based. */
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
LOGICAL RetainAll (ICollection)
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
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. */
Object ToArray () /* ToArray should not be used with large collections If there is too much data the ABL will throw: Attempt to update data exceeding 32000. (12371) */
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
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 */
ToTable (table-handle)
Inherited from OpenEdge.Core.Collections.AbstractTTCollection

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

Property Summary
Options Name Purpose
INTEGER Size
Inherited from OpenEdge.Core.Collections.AbstractTTCollection


Method Detail
Top

PUBLIC 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

PUBLIC LOGICAL Add (Object)

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Parameters:
newObject Object
Returns LOGICAL
Top

PUBLIC LOGICAL Add (String)

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

PUBLIC LOGICAL AddAll (ICollection)

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Parameters:
newCollection ICollection
Returns LOGICAL
Top

PUBLIC 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

PUBLIC 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

PUBLIC LOGICAL AddArray (Object[])

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Parameters:
objectArray Object
Returns LOGICAL
Top

PUBLIC 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

PUBLIC Clear ()

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Top

PUBLIC Object Clone ()

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
/* Deep clone. or rather deep enough since we don't know what the elements' Clone()
operations do, so this may end up being a memberwise clone
Returns Object
Top

PROTECTED CloneElements (ICollection)

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Parameters:
poClone ICollection
Top

PUBLIC 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

PUBLIC LOGICAL Contains (Object)

Overrides OpenEdge.Core.Collections.Collection:Contains (Object)
Parameters:
checkObject Object
Returns LOGICAL
Top

PUBLIC 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

PUBLIC LOGICAL ContainsAll (ICollection)

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Parameters:
poCollection ICollection
Returns LOGICAL
Top

PUBLIC LOGICAL Equals (Object)

Inherited from OpenEdge.Core.Collections.Collection
/* Two Collections are defined to be equal if they are the same size and
all of the elements in this collection are in the to-compare collection
Parameters:
o Object
Returns LOGICAL
logical TRUE if the collections are equal. FALSE otherwise
Top

PROTECTED FindBufferUseObject (Object)

Overrides OpenEdge.Core.Collections.Collection:FindBufferUseObject (Object)
/* override this in subclass - used by remove(obj) and others
Parameters:
obj Object
Top

PROTECTED FindBufferUseObject (Object, buffer)

Inherited from OpenEdge.Core.Collections.Collection
Parameters:
obj Object
pbCollection buffer
Top

PUBLIC LOGICAL IsEmpty ()

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Returns LOGICAL
Top

PUBLIC IIterator Iterator ()

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
/* Returns a new IIterator over the collection.
Returns IIterator
Top

PUBLIC 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

PUBLIC LOGICAL Remove (Object)

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Parameters:
oldObject Object
Returns LOGICAL
Top

PUBLIC LOGICAL Remove (String)

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

PUBLIC LOGICAL RemoveAll (ICollection)

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Parameters:
collection ICollection
Returns LOGICAL
Top

PUBLIC 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

PROTECTED Resize ()

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Purpose: Recalculates the Size of this collections.
Used particularly by Lists since there are operations
like Remove() that are index-based and not item-based.
Top

PUBLIC LOGICAL RetainAll (ICollection)

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Parameters:
oCol ICollection
Returns LOGICAL
Top

PUBLIC 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

PUBLIC Object ToArray ()

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
/* ToArray should not be used with large collections
If there is too much data the ABL will throw:
Attempt to update data exceeding 32000. (12371)
Returns Object
Top

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

PUBLIC ToTable (table-handle)

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Parameters:
tt TABLE-HANDLE


Constructor Detail
Top

PUBLIC StringCollection ()

Top

PUBLIC StringCollection (IStringCollection)

Parameters:
poCollection OpenEdge.Core.Collections.IStringCollection


Property Detail
Top

PUBLIC INTEGER Size

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Returns INTEGER


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0