org.biojava.bio.structure
Class AtomIterator

java.lang.Object
  org.biojava.bio.structure.AtomIterator

All Implemented Interfaces:

Iterator

public class AtomIterator
extends Object
implements Iterator

an iterator over all atoms of a structure / group.

Since:

1.4

Version:

%I% %G%

Author:

Andreas Prlic

Constructor Summary

AtomIterator(Group g)
Constructs an AtomIterator object.

AtomIterator(Structure struct)
Constructs an AtomIterator object.

Method Summary

boolean	hasNext() is there a next atom ?
Object	next() return next atom.
void	remove() does nothing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AtomIterator

public AtomIterator(Structure struct)

Constructs an AtomIterator object.

Parameters:

struct - a Structure object

AtomIterator

public AtomIterator(Group g)

Constructs an AtomIterator object.

Parameters:

g - a Group object

Method Detail

hasNext

public boolean hasNext()

is there a next atom ?

Specified by:

hasNext in interface Iterator

next

public Object next()
            throws NoSuchElementException

return next atom.

Specified by:

next in interface Iterator

Returns:

the next Atom

Throws:

NoSuchElementException - ...

remove

public void remove()

does nothing.

Specified by:

remove in interface Iterator