Public Member Functions |
| | CheckedInputStream (InputStream *inputStream, Checksum *sum, bool own=false) |
| | Create a new instance of a CheckedInputStream.
|
| virtual | ~CheckedInputStream () |
| Checksum * | getChecksum () const |
| | Returns a Pointer to the Checksum that is in use by this CheckedInputStream.
|
| virtual long long | skip (long long num) |
| | Skips over and discards n bytes of data from this input stream.The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned.The skip method of InputStream creates a byte array and then repeatedly reads into it until num bytes have been read or the end of the stream has been reached. Subclasses are encouraged to provide a more efficient implementation of this method.- Parameters
-
| num | The number of bytes to skip. |
- Returns
- total bytes skipped
- Exceptions
-
| IOException | if an I/O error occurs. |
| UnsupportedOperationException | if the concrete stream class does not support skipping bytes. |
|
| | FilterInputStream (InputStream *inputStream, bool own=false) |
| | Constructor to create a wrapped InputStream.
|
| virtual | ~FilterInputStream () |
| virtual int | available () const |
| | Indicates the number of bytes available.The default implementation of this methods returns 0. Classes that override this method may return the total number of bytes that are currently available for reading and others may simply return a value of one indicating that there is some data avaiable. The caller should view the result of this method as an absolute.The default implementation of this method returns zero.- Returns
- the number of bytes available on this input stream.
- Exceptions
-
|
| virtual void | close () |
| | Closes the InputStream freeing any resources that might have been acquired during the lifetime of this stream.The default implementation of this method does nothing.- Exceptions
-
|
| virtual void | mark (int readLimit) |
| | Marks the current position in the stream A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.If a stream instance reports that marks are supported then the stream will ensure that the same bytes can be read again after the reset method is called so long the readLimit is not reached.Calling mark on a closed stream instance should have no effect.The default implementation of this method does nothing.- Parameters
-
| readLimit | The max bytes read before marked position is invalid. |
|
| virtual void | reset () |
| | Repositions this stream to the position at the time the mark method was last called on this input stream.If the method markSupported returns true, then:
- If the method mark has not been called since the stream was created, or the number of bytes read from the stream since mark was last called is larger than the argument to mark at that last call, then an IOException might be thrown.
- If such an IOException is not thrown, then the stream is reset to a state such that all the bytes read since the most recent call to mark (or since the start of the file, if mark has not been called) will be resupplied to subsequent callers of the read method, followed by any bytes that otherwise would have been the next input data as of the time of the call to reset.
If the method markSupported returns false, then:
- The call to reset may throw an IOException.
- If an IOException is not thrown, then the stream is reset to a fixed state that depends on the particular type of the input stream and how it was created. The bytes that will be supplied to subsequent callers of the read method depend on the particular type of the input stream.
The default implementation of this method throws an IOException.- Exceptions
-
|
| virtual bool | markSupported () const |
| | Determines if this input stream supports the mark and reset methods.Whether or not mark and reset are supported is an invariant property of a particular input stream instance.The default implementation of this method returns false.- Returns
- true if this stream instance supports marks
|
| | InputStream () |
| virtual | ~InputStream () |
| virtual int | read () |
| | Reads a single byte from the buffer.
|
| virtual int | read (unsigned char *buffer, int size) |
| | Reads up to size bytes of data from the input stream into an array of bytes.
|
| virtual int | read (unsigned char *buffer, int size, int offset, int length) |
| | Reads up to length bytes of data from the input stream into an array of bytes.
|
| virtual std::string | toString () const |
| | Output a String representation of this object.
|
| virtual void | lock () |
| | Locks the object.
|
| virtual bool | tryLock () |
| | Attempts to Lock the object, if the lock is already held by another thread than this method returns false.
|
| virtual void | unlock () |
| | Unlocks the object.
|
| virtual void | wait () |
| | Waits on a signal from this object, which is generated by a call to Notify.
|
| virtual void | wait (long long millisecs) |
| | Waits on a signal from this object, which is generated by a call to Notify.
|
| virtual void | wait (long long millisecs, int nanos) |
| | Waits on a signal from this object, which is generated by a call to Notify.
|
| virtual void | notify () |
| | Signals a waiter on this object that it can now wake up and continue.
|
| virtual void | notifyAll () |
| | Signals the waiters on this object that it can now wake up and continue.
|
| virtual | ~Closeable () |
| virtual | ~Synchronizable () |
An implementation of a FilterInputStream that will maintain a Checksum of the bytes read, the Checksum can then be used to verify the integrity of the input stream.
- Since
- 1.0
| virtual long long decaf::util::zip::CheckedInputStream::skip |
( |
long long |
num | ) |
|
|
virtual |
Skips over and discards n bytes of data from this input stream.The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned.The skip method of InputStream creates a byte array and then repeatedly reads into it until num bytes have been read or the end of the stream has been reached. Subclasses are encouraged to provide a more efficient implementation of this method.
- Parameters
-
| num | The number of bytes to skip. |
- Returns
- total bytes skipped
- Exceptions
-
| IOException | if an I/O error occurs. |
| UnsupportedOperationException | if the concrete stream class does not support skipping bytes. |
Adds the skipped bytes into the Checksum.
Reimplemented from decaf::io::FilterInputStream.
Public Member Functions inherited from decaf::io::FilterInputStream