OLFrontInsertIterator Class Reference
[Insert Iterators]

An iterator that can be used to insert items into a container. More...

#import <ObjectiveLib/Iterator.h>

Inheritance diagram for OLFrontInsertIterator:

Inheritance graph
[legend]
List of all members.

Public Member Functions

(id) - assign:
 Insert object at the front of the underlying container.
(id) - copy
 Make a copy of this iterator.
(BOOL) - isEqual:
 Return whether this object is equal to another one.
Initializers and Deallocators
(id) - initWithFrontInserter:
 Initialize the iterator with the given container.

Protected Attributes

id< OLFrontInsertercontainer
 The container into which items will be inserted by the assign: message.

Detailed Description

An iterator that can be used to insert items into a container.

The iterator's assign: (OLFrontInsertIterator) message inserts the object to be assigned at the front of the container.


Member Function Documentation

- (id) assign: (id)  object  

Insert object at the front of the underlying container.

Parameters:
object the object to insert
Returns:
a reference to this iterator

Reimplemented from OLIterator.

- (id) copy  

Make a copy of this iterator.

Returns:
a copy of this iterator

Reimplemented from OLIterator.

- (id) initWithFrontInserter: (id< OLFrontInserter >)  cnr  

Initialize the iterator with the given container.

All insertions will be performed using the given container.

Precondition:
The container must support the OLFrontInserter protocol.
Parameters:
cnr the container that implements the OLFrontInserter protocol into which to insert items
Returns:
a reference to this iterator

- (BOOL) isEqual: (id)  object  

Return whether this object is equal to another one.

Parameters:
object the object to test
Returns:
YES if the iterator is equal to the object, NO if not

Reimplemented from OLIterator.


Member Data Documentation

- (id<OLFrontInserter>) container [protected]

The container into which items will be inserted by the assign: message.


The documentation for this class was generated from the following file:
ObjectiveLibGenerated Sun Apr 22 15:18:31 2007, © 2004-2007 Will Mason
SourceForge.net Logo