net.sf.japi.lang
Class SuperClassIterator

java.lang.Object
  net.sf.japi.lang.SuperClassIterator

All Implemented Interfaces:

Iterable<Class<?>>, Iterator<Class<?>>

public class SuperClassIterator
extends Object
implements Iterator<Class<?>>, Iterable<Class<?>>

An Iterator for iterating through the superclasses (subclasses to superclasses) of a class. Note: The supplied class is included in iteration. If you want to omit it, you'll have to invoke getSuperclass() once, e.g. use new SuperClassIterator(clazz.getSuperClass()) instead of new SuperClassIterator(clazz).

Author:

Christian Hujer

Constructor Summary

SuperClassIterator(Class<?> clazz)
Create a SuperClassIterator.

Method Summary

boolean	hasNext() Returns true if the iteration has more elements.
Iterator<Class<?>>	iterator() Returns an iterator over a set of elements of type T.
Class<?>	next() Returns the next element in the iteration.
void	remove() Removes from the underlying collection the last element returned by the iterator (optional operation).

Methods inherited from class java.lang.Object

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

Constructor Detail

SuperClassIterator

public SuperClassIterator(@Nullable
                          Class<?> clazz)

Create a SuperClassIterator.

Parameters:

clazz - Class to create Iterator for

Method Detail

hasNext

public boolean hasNext()

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Specified by:

hasNext in interface Iterator<Class<?>>

Returns:

true if the iterator has more elements.

next

public Class<?> next()

Returns the next element in the iteration. Calling this method repeatedly until the Iterator.hasNext() method returns false will return each element in the underlying collection exactly once.

Specified by:

next in interface Iterator<Class<?>>

Returns:

the next element in the iteration.

remove

public void remove()

Removes from the underlying collection the last element returned by the iterator (optional operation). This method can be called only once per call to next. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method.

Specified by:

remove in interface Iterator<Class<?>>

iterator

public Iterator<Class<?>> iterator()

Returns an iterator over a set of elements of type T.

Specified by:

iterator in interface Iterable<Class<?>>

Returns:

an Iterator.