de.bea.domingo.proxy
Class ViewProxy.CategoryIterator

java.lang.Object
  de.bea.domingo.proxy.ViewProxy.CategoryIterator

All Implemented Interfaces:

java.util.Iterator

Enclosing class:

ViewProxy

public final class ViewProxy.CategoryIterator
extends java.lang.Object
implements java.util.Iterator

A CategoriesIterator allows iteration over a set of lotus.domino.ViewEntrys that are categories.

Author:

Kurt Riede

See Also:

ViewProxy.getAllCategories(), ViewProxy.getAllCategories(int), ViewProxy.getAllCategoriesByKey(java.lang.String, int, boolean), ViewProxy.getAllCategoriesByKey(java.util.List, int, boolean)

Constructor Summary

protected	ViewProxy.CategoryIterator(lotus.domino.ViewNavigator theViewNavigator, lotus.domino.ViewEntry firstEntry) Constructs an CategoryIterator.
	ViewProxy.CategoryIterator(lotus.domino.ViewNavigator theViewNavigator, lotus.domino.ViewEntry firstEntry, java.lang.Object theKey, boolean isExact) Constructor.

Method Summary

protected void	finalize() The items iterator doesn't have to recycle anything.
boolean	hasNext() Indicates whether this iterator has a next element or not.
java.lang.Object	next() Returns the next element of this iterator or null if hasNext()==false.
void	remove() Throws an UnsupportedOperationException: The remove operation is not supported by this Iterator.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewProxy.CategoryIterator

protected ViewProxy.CategoryIterator(lotus.domino.ViewNavigator theViewNavigator,
                                     lotus.domino.ViewEntry firstEntry)

Constructs an CategoryIterator.

Parameters:

theViewNavigator - the ViewNavigator

firstEntry - the first entry or null of no entry is available

ViewProxy.CategoryIterator

public ViewProxy.CategoryIterator(lotus.domino.ViewNavigator theViewNavigator,
                                  lotus.domino.ViewEntry firstEntry,
                                  java.lang.Object theKey,
                                  boolean isExact)

Constructor.

Parameters:

theViewNavigator - the ViewNavigator

firstEntry - the first matching entry or null of no entry matching entry is available

theKey - the key, either a String a List

isExact - use true if you want an exact match or false for a partial

Method Detail

hasNext

public boolean hasNext()

Indicates whether this iterator has a next element or not.

Specified by:

hasNext in interface java.util.Iterator

Returns:

boolean true if there is a next

See Also:

Iterator.hasNext()

next

public java.lang.Object next()

Returns the next element of this iterator or null if hasNext()==false.

Specified by:

next in interface java.util.Iterator

Returns:

a DBaseItem

See Also:

Iterator.next()

remove

public void remove()

Throws an UnsupportedOperationException: The remove operation is not supported by this Iterator.

Specified by:

remove in interface java.util.Iterator

See Also:

Iterator.remove()

finalize

protected void finalize()
                 throws java.lang.Throwable

The items iterator doesn't have to recycle anything. All Items created within this Iterator are recycled by the Notes API.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - the Exception raised by this method

See Also:

Object.finalize()