Namespace: OpenEdge.Core.Collections
Interface
IList
Parent classes:
Inherits: OpenEdge.Core.Collections.ICollection

Copyright (c) 2013 by Progress Software Corporation. All rights reserved.
File:IList
Purpose:An ordered collection that gives control over where in the
list each element is inserted.
Allows elements to be accessed by their integer index in
addition to by the element.
Author(s):hdaniels
Created:Wed Jan 09 09:57:42 EST 2008
Notes:* All methods (and comments) except ToTable are an exact match to Java
List interface. Size is implemented as property
Purpose: Inserts the specified element at the specified position in this list.




Method Summary
Options Name Purpose
LOGICAL Add (integer, Object) /** Inserts the specified element at the specified position in this list. @param integer The position at which to insert the object @param Object The object to add @return Logical Returns true if the operation succeeded */
LOGICAL AddAll (integer, ICollection) /* Inserts all of the elements in the specified collection into this list at the specified position (optional operation). @param integer The iposition at which to add the collection @param ICollection the collection of objects to add @return logical True if the operation succeeded. */
LOGICAL AddArray (integer, Object[]) /** Appends all the elements in the array this list, optionally at the specified position. */
Progress.Lang.Object Get (integer) /** Returns the element at the specified position in this list. @param integer The index of the object to return @return Object The object returned. */
INTEGER IndexOf (Object) /** Returns the index in this list of the first occurrence of the specified element, or 0 if this list does not contain this element. @param Object The object to check. @return integer The index of the passed-in object */
INTEGER LastIndexOf (Object) /** Returns the index in this list of the last occurrence of the specified element, or 0 if this list does not contain this element. @param Object The object to check @return integer The index of the last occurrence of the object */
OpenEdge.Core.Collections.IListIterator ListIterator () /* Returns a list iterator over the elements in this list in proper sequence. @return IListIterator The ordered iterator */
OpenEdge.Core.Collections.IListIterator ListIterator (integer) /** Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. @param integer The starting position for the new iterator @return IListIterator The ordered iterator */
Progress.Lang.Object Remove (integer) /** Removes the element at the specified position in this list @param integer The index to remove @return Object The object that was removed. */
Progress.Lang.Object Set (integer, Object) /** Replaces the element at the specified position in this list with the specified element @param integer The position to add @param Object The object to add to the List @return Object The object that was replaced/removed from the List */
OpenEdge.Core.Collections.IList SubList (integer, integer) /** Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. @param integer The starting position for the new List (included) @param integer The end position for the new List (excluded) @return IList The new List */


Method Detail
Top

LOGICAL Add (integer, Object)

Purpose: Inserts the specified element at the specified position in this list.
Parameters:
piIndex INTEGER
poElement Progress.Lang.Object
Returns LOGICAL
Logical Returns true if the operation succeeded
Top

LOGICAL AddAll (integer, ICollection)

/* Inserts all of the elements in the specified collection into this list
at the specified position (optional operation).
Parameters:
piIndex INTEGER
poCollection OpenEdge.Core.Collections.ICollection
Returns LOGICAL
logical True if the operation succeeded.
Top

LOGICAL AddArray (integer, Object[])

Purpose: Appends all the elements in the array this list, optionally
at the specified position.
Parameters:
piIndex INTEGER
c Progress.Lang.Object
Returns LOGICAL
Top

Progress.Lang.Object Get (integer)

Purpose: Returns the element at the specified position in this list.
Parameters:
piIndex INTEGER
Returns Progress.Lang.Object
Object The object returned.
Top

INTEGER IndexOf (Object)

Purpose: Returns the index in this list of the first occurrence of the specified
element, or 0 if this list does not contain this element.
Parameters:
poElement Progress.Lang.Object
Returns INTEGER
integer The index of the passed-in object
Top

INTEGER LastIndexOf (Object)

Purpose: Returns the index in this list of the last occurrence of the
specified element, or 0 if this list does not contain this element.
Parameters:
poElement Progress.Lang.Object
Returns INTEGER
integer The index of the last occurrence of the object
Top

OpenEdge.Core.Collections.IListIterator ListIterator ()

/* Returns a list iterator over the elements in this list in proper sequence.
Returns OpenEdge.Core.Collections.IListIterator
IListIterator The ordered iterator
Top

OpenEdge.Core.Collections.IListIterator ListIterator (integer)

Purpose: Returns a list iterator of the elements in this list (in proper sequence),
starting at the specified position in this list.
Parameters:
piIndex INTEGER
Returns OpenEdge.Core.Collections.IListIterator
IListIterator The ordered iterator
Top

Progress.Lang.Object Remove (integer)

Purpose: Removes the element at the specified position in this list
Parameters:
piIndex INTEGER
Returns Progress.Lang.Object
Object The object that was removed.
Top

Progress.Lang.Object Set (integer, Object)

Purpose: Replaces the element at the specified position in this list with the
specified element
Parameters:
piIndex INTEGER
poElement Progress.Lang.Object
Returns Progress.Lang.Object
Object The object that was replaced/removed from the List
Top

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

Purpose: Returns a view of the portion of this list between the specified
fromIndex, inclusive, and toIndex, exclusive.
Parameters:
poFromPosition INTEGER
poToPosition INTEGER
Returns OpenEdge.Core.Collections.IList
IList The new List


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7.15