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)
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) */
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 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 */
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)
OpenEdge.Core.Collections.IIterator Iterator () /* Returns a new IIterator over the collection. */
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)
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. */

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


Method Detail
Top

LOGICAL Add (integer, Object)

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

LOGICAL Add (Object)

Parameters:
obj Progress.Lang.Object
Returns LOGICAL
Top

LOGICAL 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

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

LOGICAL AddArray (integer, Object[])

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

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

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

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

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

INTEGER IndexOf (Object)

Parameters:
obj Progress.Lang.Object
Returns INTEGER
Top

OpenEdge.Core.Collections.IIterator Iterator ()

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

INTEGER LastIndexOf (Object)

Parameters:
obj Progress.Lang.Object
Returns INTEGER
Top

OpenEdge.Core.Collections.IListIterator ListIterator ()

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

OpenEdge.Core.Collections.IListIterator ListIterator (integer)

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

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

LOGICAL Remove (Object)

Parameters:
oldObject Progress.Lang.Object
Returns LOGICAL
Top

Progress.Lang.Object Set (integer, Object)

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

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.


Constructor Detail
Top

List ()

/* Default constructor
Top

List (handle, character)

Parameters:
phtt HANDLE
pcField CHARACTER
Top

List (handle, handle)

Parameters:
phtt HANDLE
hField HANDLE
Top

List (ICollection, handle, character)

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

List (IList)

Parameters:
list OpenEdge.Core.Collections.IList


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7.15