Package com.sun.javatest.util
Class ReadAheadIterator
- java.lang.Object
-
- com.sun.javatest.util.ReadAheadIterator
-
- All Implemented Interfaces:
java.util.Iterator
public class ReadAheadIterator extends java.lang.Object implements java.util.Iterator
An iterator that can read ahead of the current position, either for performance reasons or to help find out the number of items returned by an iterator before accessing them.
-
-
Constructor Summary
Constructors Constructor Description ReadAheadIterator(java.util.Iterator source, int mode)
Create a ReadAheadIterator.ReadAheadIterator(java.util.Iterator source, int mode, int amount)
Create a ReadAheadIterator.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
getItemsFoundCount()
Get the number of items read (so far) from the underlying source iterator.int
getOutputQueueSize()
Deprecated.Will not be supported in the future.int
getUsedElementCount()
Deprecated.Will not be supported in the future.boolean
hasNext()
boolean
isReadAheadComplete()
Check if all available items from the underlying source iterator have been read.boolean
isSourceExhausted()
Deprecated.Use hasNext().java.lang.Object
next()
void
remove()
-
-
-
Constructor Detail
-
ReadAheadIterator
public ReadAheadIterator(java.util.Iterator source, int mode)
Create a ReadAheadIterator.
-
ReadAheadIterator
public ReadAheadIterator(java.util.Iterator source, int mode, int amount)
Create a ReadAheadIterator.- Parameters:
source
- The iterator from which to read ahead.mode
- A value indicating the type of read ahead required.amount
- A value indicating the amount of read ahead required, if the mode is set to LIMITED. If the mode is NON or FULL, this parameter will be ignored.- See Also:
NONE
,LIMITED
,FULL
-
-
Method Detail
-
isReadAheadComplete
public boolean isReadAheadComplete()
Check if all available items from the underlying source iterator have been read.- Returns:
- true if all available items from the underlying source iterator have been read.
-
getItemsFoundCount
public int getItemsFoundCount()
Get the number of items read (so far) from the underlying source iterator. If the read ahead has not yet completed, this will be a partial count of the total set of items available to be read. If the read ahead is complete, the value will be the total number of items returned from the underlying source iterator.- Returns:
- the number of items (so far) from the underlying source iterator.
- See Also:
isReadAheadComplete()
-
isSourceExhausted
public boolean isSourceExhausted()
Deprecated.Use hasNext().Are there items that have not be read-ahead yet?- Returns:
- True if the source has no more elements, false otherwise.
-
getUsedElementCount
public int getUsedElementCount()
Deprecated.Will not be supported in the future.How many elements have been distributed throughgetNext()
.- Returns:
- number of used elements, greater-than or equal-to zero
- See Also:
getItemsFoundCount()
-
getOutputQueueSize
public int getOutputQueueSize()
Deprecated.Will not be supported in the future.Number of items have been read-ahead by not distributed.- Returns:
- number of items ready to be distributed, greater-than or equal-to zero
-
hasNext
public boolean hasNext()
- Specified by:
hasNext
in interfacejava.util.Iterator
-
next
public java.lang.Object next()
- Specified by:
next
in interfacejava.util.Iterator
-
remove
public void remove()
- Specified by:
remove
in interfacejava.util.Iterator
- Throws:
java.lang.UnsupportedOperationException
-
-