Package org.apache.commons.io
Class StreamIterator<E>
java.lang.Object
org.apache.commons.io.StreamIterator<E>
- Type Parameters:
E
- The stream and iterator type.
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Iterator<E>
Wraps and presents a stream as a closable iterator resource that automatically closes itself when reaching the end
of stream.
- Since:
- 2.9.0
-
Field Details
-
iterator
-
stream
-
-
Constructor Details
-
StreamIterator
-
-
Method Details
-
iterator
Wraps and presents a stream as a closable resource that automatically closes itself when reaching the end of stream.Warning
In order to close the stream, the call site MUST either close the stream it allocated OR call the iterator until the end.
- Type Parameters:
T
- The stream and iterator type.- Parameters:
stream
- The stream iterate.- Returns:
- A new iterator.
-
close
public void close()Closes the underlying stream.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
-
hasNext
public boolean hasNext() -
next
-