Namespace: OpenEdge.Core.Collections
Class
List
Parent classes:
Inherits: OpenEdge.Core.Collections.AbstractTTCollection
Implements: OpenEdge.Core.Collections.IList

Copyright (c) 2013, 2016-2019 by Progress Software Corporation. All rights reserved.
File:List
Author(s):hdaniels
Created:Wed Jan 09 10:45:45 EST 2008
/* default temp-table




Method Summary
Options Name Purpose
LOGICAL Add (integer, Object)
LOGICAL Add (Object)
Overrides OpenEdge.Core.Collections.AbstractTTCollection:Add (Object)
LOGICAL AddAll (ICollection) /** Adds all of the input collection to the current list. Items from the input collection as added to the END of the current list. To prepend items, call AddAll(1, ICollection) @param ICollection The collection to add. @return logical TRUE if items were added (ie the input collection has at least one item) */
Overrides OpenEdge.Core.Collections.AbstractTTCollection:AddAll (ICollection)
LOGICAL AddAll (integer, ICollection) /** Adds all of the input collection to the current list, starting at the index given (ie the index passed is the first item) @param integer The index from which to add. Must be non-zero and positive @param ICollection The collection to add @return logical TRUE if items were added (ie the input collection has at least one item) */
LOGICAL AddArray (integer, Object[])
LOGICAL AddArray (Object[])
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Clear ()
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Progress.Lang.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 (Object)
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
LOGICAL ContainsAll (ICollection)
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
LOGICAL Equals (Object) /* Two Lists are defined to be equal if they are the same size and all of the elements in this collection are in the to-compare List and in the same sequence. @param P.L.Object @return logical TRUE if the Lists are equal. FALSE otherwise */
FindBufferUseObject (Object) /* Find the FIRST reference of the search object; the search order is by the List's Sequence. This means that if there are 2 instances of this object, a dev will need to iterate over the collection to determine which ones match. @param Progress.Lang.Object The search object */
Overrides OpenEdge.Core.Collections.AbstractTTCollection:FindBufferUseObject (Object)
FindBufferUseObject (Object, buffer) /* Find the FIRST reference of the search object; the search order is by the List's Sequence. This means that if there are 2 instances of this object, a dev will need to iterate over the collection to determine which ones match. The input buffer is RELEASED (so that we don't leak scope). @param Progress.Lang.Object The search object @param buffer ttList The buffer to search */
Progress.Lang.Object Get (integer) /* Returns the object represented by the index @param integer The sequence to find. Must be positive and <= the Size. @return Object The object represented by the sequence. May be ? */
INTEGER IndexOf (Object)
LOGICAL IsEmpty ()
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
OpenEdge.Core.Collections.IIterator Iterator () /* Returns a new IIterator over the collection. */
Overrides OpenEdge.Core.Collections.AbstractTTCollection:Iterator ()
INTEGER LastIndexOf (Object)
OpenEdge.Core.Collections.IListIterator ListIterator () /* Returns a new IListIterator over the collection. */
OpenEdge.Core.Collections.IListIterator ListIterator (integer) /* Returns a new IListIterator over the collection.*/
Progress.Lang.Object Remove (integer) /** Removes an item at the given index @param integer The index to remove. Must be between 1 and the size of the List @return Progress.Lang.Object The item that was removed. */
LOGICAL Remove (Object)
Overrides OpenEdge.Core.Collections.AbstractTTCollection:Remove (Object)
LOGICAL RemoveAll (ICollection)
Inherited from OpenEdge.Core.Collections.AbstractTTCollection
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
Progress.Lang.Object Set (integer, Object)
OpenEdge.Core.Collections.IList SubList (integer, integer) /* Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. The fromIndex value must be positive and <= this list's Size The toIndex value must be positive and <= this list's Size The fromIndex value must be <= toIndex value If fromIndex and toIndex are equal, the returned list has 1 entry. @param integer fromIndex Low endpoint (INCLUSIVE) of the subList @param integer toIndex High endpoint (INCLUSIVE) of the subList @return IList a List containing the items. Has at least 1 entry. */
Progress.Lang.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
ToTable (table-handle)
Inherited from OpenEdge.Core.Collections.AbstractTTCollection

Constructor Summary
Options Name Purpose
List () /* Default constructor */
List (handle, character)
List (handle, handle)
List (ICollection, handle, character)
List (IList)

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


Method Detail
Top

PUBLIC LOGICAL Add (integer, Object)

Parameters:
seq INTEGER
obj Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC LOGICAL Add (Object)

Overrides OpenEdge.Core.Collections.AbstractTTCollection:Add (Object)
Parameters:
obj Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC LOGICAL AddAll (ICollection)

Overrides OpenEdge.Core.Collections.AbstractTTCollection:AddAll (ICollection)
Purpose: Adds all of the input collection to the current list.
Items from the input collection as added to the END of
the current list.
To prepend items, call AddAll(1, ICollection)
Parameters:
c OpenEdge.Core.Collections.ICollection
Returns LOGICAL
logical TRUE if items were added (ie the input collection has at least one item)
Top

PUBLIC LOGICAL AddAll (integer, ICollection)

Purpose: Adds all of the input collection to the current list, starting at the
index given (ie the index passed is the first item)
Parameters:
seq INTEGER
c OpenEdge.Core.Collections.ICollection
Returns LOGICAL
logical TRUE if items were added (ie the input collection has at least one item)
Top

PUBLIC LOGICAL AddArray (integer, Object[])

Parameters:
seq INTEGER
obj Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC LOGICAL AddArray (Object[])

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

PUBLIC Clear ()

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Top

PUBLIC Progress.Lang.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 Progress.Lang.Object
Top

PROTECTED CloneElements (ICollection)

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

PUBLIC LOGICAL Contains (Object)

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Parameters:
checkObject Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC LOGICAL ContainsAll (ICollection)

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

PUBLIC LOGICAL Equals (Object)

/* Two Lists are defined to be equal if they are the same size and
all of the elements in this collection are in the to-compare List and
in the same sequence.
Parameters:
o Progress.Lang.Object
Returns LOGICAL
logical TRUE if the Lists are equal. FALSE otherwise
Top

PROTECTED FindBufferUseObject (Object)

Overrides OpenEdge.Core.Collections.AbstractTTCollection:FindBufferUseObject (Object)
/* Find the FIRST reference of the search object; the search order
is by the List's Sequence. This means that if there are 2 instances
of this object, a dev will need to iterate over the collection to
determine which ones match.
Parameters:
findObject Progress.Lang.Object
Top

PROTECTED FindBufferUseObject (Object, buffer)

/* Find the FIRST reference of the search object; the search order
is by the List's Sequence. This means that if there are 2 instances
of this object, a dev will need to iterate over the collection to
determine which ones match.
The input buffer is RELEASED (so that we don't leak scope).
Parameters:
findObject Progress.Lang.Object
pbList buffer
Top

PUBLIC Progress.Lang.Object Get (integer)

/* Returns the object represented by the index
Parameters:
i INTEGER
Returns Progress.Lang.Object
Object The object represented by the sequence. May be ?
Top

PUBLIC INTEGER IndexOf (Object)

Parameters:
obj Progress.Lang.Object
Returns INTEGER
Top

PUBLIC LOGICAL IsEmpty ()

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

PUBLIC OpenEdge.Core.Collections.IIterator Iterator ()

Overrides OpenEdge.Core.Collections.AbstractTTCollection:Iterator ()
/* Returns a new IIterator over the collection.
Returns OpenEdge.Core.Collections.IIterator
Top

PUBLIC INTEGER LastIndexOf (Object)

Parameters:
obj Progress.Lang.Object
Returns INTEGER
Top

PUBLIC OpenEdge.Core.Collections.IListIterator ListIterator ()

/* Returns a new IListIterator over the collection.
Returns OpenEdge.Core.Collections.IListIterator
Top

PUBLIC OpenEdge.Core.Collections.IListIterator ListIterator (integer)

/* Returns a new IListIterator over the collection.
Parameters:
i INTEGER
Returns OpenEdge.Core.Collections.IListIterator
Top

PUBLIC Progress.Lang.Object Remove (integer)

Purpose: Removes an item at the given index
Parameters:
i INTEGER
Returns Progress.Lang.Object
Progress.Lang.Object The item that was removed.
Top

PUBLIC LOGICAL Remove (Object)

Overrides OpenEdge.Core.Collections.AbstractTTCollection:Remove (Object)
Parameters:
oldObject Progress.Lang.Object
Returns LOGICAL
Top

PUBLIC LOGICAL RemoveAll (ICollection)

Inherited from OpenEdge.Core.Collections.AbstractTTCollection
Parameters:
collection OpenEdge.Core.Collections.ICollection
Returns LOGICAL
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 OpenEdge.Core.Collections.ICollection
Returns LOGICAL
Top

PUBLIC Progress.Lang.Object Set (integer, Object)

Parameters:
i INTEGER
poReplacement Progress.Lang.Object
Returns Progress.Lang.Object
Top

PUBLIC OpenEdge.Core.Collections.IList SubList (integer, integer)

/* Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
The fromIndex value must be positive and <= this list's Size
The toIndex value must be positive and <= this list's Size
The fromIndex value must be <= toIndex value
If fromIndex and toIndex are equal, the returned list has 1 entry.
Parameters:
fromIndex INTEGER
toIndex INTEGER
Returns OpenEdge.Core.Collections.IList
IList a List containing the items. Has at least 1 entry.
Top

PUBLIC Progress.Lang.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 Progress.Lang.Object
Top

PUBLIC ToTable (table-handle)

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


Constructor Detail
Top

PUBLIC List ()

/* Default constructor
Top

PROTECTED List (handle, character)

Parameters:
phtt HANDLE
pcField CHARACTER
Top

PROTECTED List (handle, handle)

Parameters:
phtt HANDLE
hField HANDLE
Top

PROTECTED List (ICollection, handle, character)

Parameters:
poCol OpenEdge.Core.Collections.ICollection
phtt HANDLE
pcField CHARACTER
Top

PUBLIC List (IList)

Parameters:
list OpenEdge.Core.Collections.IList


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