- All Known Implementing Classes:
public interface MeasurableStream
This class has two methods, both specified as optional. This apparently bizarre
behaviour is necessary because of wrapper classes which use reflection
to support those methods (see, e.g.,
Modifier and Type Method Description
()Returns the overall length of this stream (optional operation).
()Returns the current position in this stream (optional operation).
lengthlong length() throws java.io.IOExceptionReturns the overall length of this stream (optional operation). In most cases, this will require the stream to perform some extra action, possibly changing the state of the input stream itself (typically, reading all the bytes up to the end, or flushing on output stream). Implementing classes should always document what state will the input stream be in after calling this method, and which kind of exception could be thrown.
positionlong position() throws java.io.IOExceptionReturns the current position in this stream (optional operation).
Usually, the position is just the number of bytes read or written since the stream was opened, but in the case of a
RepositionableStreamit represent the current position.