com.ibm.cics.server
Class ContainerIterator

java.lang.Object
  extended bycom.ibm.cics.server.ContainerIterator
All Implemented Interfaces:
java.util.Iterator

public class ContainerIterator
extends java.lang.Object
implements java.util.Iterator

This is the ContainerIterator which allows CICS Java programs to browse all Containers in a Channel.


Method Summary
 java.lang.Object getOwner()
          Get the owner of this iterator.
 boolean hasNext()
          Determine if there is another Container in the Channel.
 java.lang.Object next()
          Get the next Container from the Channel.
 void remove()
          Remove an element from the Channel.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getOwner

public java.lang.Object getOwner()
Get the owner of this iterator.

Returns:
The owning Channel.

hasNext

public boolean hasNext()
Determine if there is another Container in the Channel. If there is, and the Container does not already exist in Java, create a Container object to represent it.

Specified by:
hasNext in interface java.util.Iterator
Returns:
true if there is another Container, otherwise false.

next

public java.lang.Object next()
                      throws java.util.NoSuchElementException
Get the next Container from the Channel.

Specified by:
next in interface java.util.Iterator
Returns:
The next Container
Throws:
java.util.NoSuchElementException

remove

public void remove()
            throws java.lang.UnsupportedOperationException
Remove an element from the Channel. This Iterator method is not supported. A Container can only be removed from the Channel when it is deleted.

Specified by:
remove in interface java.util.Iterator
Throws:
java.lang.UnsupportedOperationException