InputSource
Related Doc:
package io
Determine whether the underlying data has the specified number of bytes available starting at the current byte position.
Determine whether the underlying data has the specified number of bytes available starting at the current byte position. This function must block until either nBytes are known to be available or end-of-file is reached. This does not advance the current position.
the number of bytes to determine if are available
true if nBytes are available, false otherwise
Return the number of currently available bytes.
Return the number of currently available bytes.
This should not be used to determine the length of the data, as more bytes may become available in the future. This should really only be used for debug purposes.
Alerts the implementation to attempt to free data that is no longer used, if possible.
Alerts the implementation to attempt to free data that is no longer used, if possible. If possible, this should free any unlocked bytes.
Return a byte array with data from the current byte position.
Return a byte array with data from the current byte position.
Stores the next len bytes of data in dest starting at index off. In len bytes are not available or len bytes cannot fit in the dest array starting at the given offset, the dest array is not modified and false is returned.
true if len bytes are available and written to the dest array, false otherwise
Return a single byte at the current byte position with a value in the range of 0 to 255.
Return a single byte at the current byte position with a value in the range of 0 to 255.
Increments the current byte position if successful.
the byte at the current byte position if it exists, or -1 if EOF is reached.
Set the specified byte position as a location that that one may want to call setPosition in the future.
Set the specified byte position as a location that that one may want to call setPosition in the future. This is essentially setting a mark in the data that can be reset back to later. Implementations are allowed to free any bytes before a locked byte position. Any bytes after a locked position cannot be freed until that lock is release.
Note that this "lock" has nothing to do with synchronization, but behaves more like marks that must be accessable until released.
the byte position to lock
Set the current byte position, using zero-based indexing
Set the current byte position, using zero-based indexing
bytPos0b cannot be greater than the most recent read data. In other words, this can only be used to move backwards in data.
the new current byte position
Get the current byte position, using zero-based indexing
Get the current byte position, using zero-based indexing
the current byte position
Release a previously locked byte position, allowing the implementation to free any unlocked bytes.
Release a previously locked byte position, allowing the implementation to free any unlocked bytes.
the byte position to release
The InputSource class is really just a mechanism to provide bytes an InputSourceDataInputStream, which does the heavily lift about converter bits/bytes to numbers and characters. This class does not need to know anything about bits, it is purely byte centric. One core difference from this vs an InputStream is that is must have the capability to backtrack to arbitrary points in the InputStreams history. To aide in this, methods are called to let the InputSource know which byte positions might we might need to backtrack to, which can allow it to free data that know longer is needed. One can almost thing of things as an InputStream that supports multiple marks with random access.