nsIRandomAccessIterator

IID:9bd6fdb0-1dd1-11b2-9101-d15375968230
Inherits From:nsISupports

Methods

nsISupports clone ( ) nsISupports getElement ( ) nsISupports getElementAt ( PRInt32 anOffset ) PRBool isEqualTo ( nsISupports anotherIterator ) void putElement ( nsISupports anElementToPut ) void putElementAt ( PRInt32 anOffset , nsISupports anElementToPut ) void stepBackward ( ) void stepBackwardBy ( PRInt32 anOffset ) void stepForward ( ) void stepForwardBy ( PRInt32 anOffset )

nsISupports clone ( )

Create a new iterator pointing to the same position in the underlying container or sequence to which this iterator currently points. The returned iterator is suitable for use in a subsequent call to isEqualTo() against this iterator.


nsISupports getElement ( )

Retrieve (and AddRef()) the element this iterator currently points to.

The result is undefined if this iterator currently points outside the useful range of the underlying container or sequence.


nsISupports getElementAt ( PRInt32 anOffset )

Retrieve (and AddRef()) an element at some offset from where this iterator currently points. The offset may be negative. getElementAt(0) is equivalent to getElement().

The result is undefined if this iterator currently points outside the useful range of the underlying container or sequence.

Arguments:
anOffset: a |0|-based offset from the position to which this iterator currently points

PRBool isEqualTo ( nsISupports anotherIterator )

Test if anotherIterator points to the same position in the underlying container or sequence.

The result is undefined if anotherIterator was not created by or for the same underlying container or sequence.

Arguments:
anotherIterator: another iterator to compare against, created by or for the same underlying container or sequence

void putElement ( nsISupports anElementToPut )

Put anElementToPut into the underlying container or sequence at the position currently pointed to by this iterator. The iterator and the underlying container or sequence cooperate to Release() the replaced element, if any and if necessary, and to AddRef() the new element.

The result is undefined if this iterator currently points outside the useful range of the underlying container or sequence.

Arguments:
anElementToPut: the element to place into the underlying container or sequence

void putElementAt ( PRInt32 anOffset , nsISupports anElementToPut )

Put anElementToPut into the underlying container or sequence at the position anOffset away from that currently pointed to by this iterator. The iterator and the underlying container or sequence cooperate to Release() the replaced element, if any and if necessary, and to AddRef() the new element. putElementAt(0, obj) is equivalent to putElement(obj).

The result is undefined if this iterator currently points outside the useful range of the underlying container or sequence.

Arguments:
anOffset: a |0|-based offset from the position to which this iterator currently points
anElementToPut: the element to place into the underlying container or sequence

void stepBackward ( )

Move this iterator to the previous position in the underlying container or sequence.


void stepBackwardBy ( PRInt32 anOffset )

Move this iterator backwards by anOffset positions in the underlying container or sequence. anOffset may be negative. stepBackwardBy(1) is equivalent to stepBackward(). stepBackwardBy(n) is equivalent to stepForwardBy(-n). stepBackwardBy(0) is a no-op.

Arguments:
anOffset: a |0|-based offset from the position to which this iterator currently points

void stepForward ( )

Advance this iterator to the next position in the underlying container or sequence.


void stepForwardBy ( PRInt32 anOffset )

Move this iterator by anOffset positions in the underlying container or sequence. anOffset may be negative. stepForwardBy(1) is equivalent to stepForward(). stepForwardBy(0) is a no-op.

Arguments:
anOffset: a |0|-based offset from the position to which this iterator currently points

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com