- All Superinterfaces:
- All Known Subinterfaces:
- All Known Implementing Classes:
public interface ObjectStream<T> extends java.lang.AutoCloseableReads
Objects from a stream.
This interface provides a means for iterating over the objects in a stream, it does not implement
Iterator.hasNext()are declared as throwing no checked exceptions. Thus the
IOExceptions thrown by
read()would have to be wrapped in
RuntimeExceptions, and the compiler would be unable to force users of this code to catch such exceptions.
Iterablewould mean either silently calling
reset()to guarantee that all items were always seen on each iteration, or documenting that the Iterable only iterates over the remaining elements of the ObjectStream. In either case, users not reading the documentation carefully might run into unexpected behavior.
- See Also:
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description
ObjectStreamand releases all allocated resources.
read()Returns the next object.
reset()Repositions the stream at the beginning and the previously seen object sequence will be repeated exactly.
T read() throws java.io.IOExceptionReturns the next object. Calling this method repeatedly until it returns null will return each object from the underlying source exactly once.
- the next object or null to signal that the stream is exhausted
java.io.IOException- if there is an error during reading
default void reset() throws java.io.IOException, java.lang.UnsupportedOperationExceptionRepositions the stream at the beginning and the previously seen object sequence will be repeated exactly. This method can be used to re-read the stream if multiple passes over the objects are required. The implementation of this method is optional.
java.io.IOException- if there is an error during reseting the stream
default void close() throws java.io.IOExceptionCloses the
ObjectStreamand releases all allocated resources. After close was called its not allowed to call read or reset.
- Specified by:
java.io.IOException- if there is an error during closing the stream