com.ibm.cics.server
Class ContainerIterator

java.lang.Object
  extended by com.ibm.cics.server.ContainerIterator
All Implemented Interfaces:
java.util.Iterator<Container>

public class ContainerIterator
extends java.lang.Object
implements java.util.Iterator<Container>

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

Since CICS TS version:
3.1
Since package version:
1.0

Method Summary
 java.lang.Object getOwner()
          Get the owner of this iterator.
 boolean hasNext()
          Determine if there is another Container in the Channel.
 Container 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.
Since CICS TS version:
3.1
Since package version:
1.0

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<Container>
Returns:
true if there is another Container, otherwise false.
Since CICS TS version:
3.1
Since package version:
1.0

next

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

Specified by:
next in interface java.util.Iterator<Container>
Returns:
The next Container
Throws:
java.util.NoSuchElementException - there are no more containers left
Since CICS TS version:
4.1
Since package version:
1.200

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<Container>
Throws:
java.lang.UnsupportedOperationException - if the method is called
Since CICS TS version:
3.1
Since package version:
1.0