Class ResettableInputStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Releasable
ResettableInputStream
allows the close operation to
be disabled via ReleasableInputStream.disableClose()
(to avoid accidentally being closed).
This is necessary when such input stream needs to be marked-and-reset
multiple times but only as long as the stream has not been closed.
The creator of this input stream should therefore always call
ReleasableInputStream.release()
in a finally block to truly release the underlying
resources.
- See Also:
-
Constructor Summary
ConstructorDescriptionResettableInputStream
(File file) Note the creation of aResettableInputStream
would entail physically opening a file. -
Method Summary
Modifier and TypeMethodDescriptionint
getFile()
Returns the underlying file, if known; or null if not;void
mark
(int ignored) Marks the current position in this input stream.final boolean
static ResettableInputStream
newResettableInputStream
(File file) Convenient factory method to construct a new resettable input stream for the given file, converting any IOException into SdkClientException.static ResettableInputStream
Convenient factory method to construct a new resettable input stream for the given file input stream, converting any IOException into SdkClientException.static ResettableInputStream
newResettableInputStream
(FileInputStream fis, String errmsg) Convenient factory method to construct a new resettable input stream for the given file input stream, converting any IOException into SdkClientException with the given error message.static ResettableInputStream
newResettableInputStream
(File file, String errmsg) Convenient factory method to construct a new resettable input stream for the given file, converting any IOException into SdkClientException with the given error message.int
read()
int
read
(byte[] arg0, int arg1, int arg2) void
reset()
Repositions this stream to the position at the time themark
method was last called on this input stream.long
skip
(long n) Methods inherited from class software.amazon.awssdk.core.io.ReleasableInputStream
close, disableClose, isCloseDisabled, release, wrap
Methods inherited from class java.io.FilterInputStream
read
-
Constructor Details
-
ResettableInputStream
- Parameters:
file
- must not be null. Upon successful construction the the file will be opened with an input stream automatically marked at the starting position of the given file.Note the creation of a
ResettableInputStream
would entail physically opening a file. If the opened file is meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release method must not be called while the execution is made in other stack frames. In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the stream would need to explicitly disable the accidental closing viaReleasableInputStream.disableClose()
, so that the release method becomes the only way to truly close the opened file.- Throws:
IOException
-
ResettableInputStream
Note the creation of a
ResettableInputStream
would entail physically opening a file. If the opened file is meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release method must not be called while the execution is made in other stack frames. In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the stream would need to explicitly disable the accidental closing viaReleasableInputStream.disableClose()
, so that the release method becomes the only way to truly close the opened file.- Parameters:
fis
- file input stream; must not be null. Upon successful construction the input stream will be automatically marked at the current position of the given file input stream.- Throws:
IOException
-
-
Method Details
-
newResettableInputStream
Convenient factory method to construct a new resettable input stream for the given file, converting any IOException into SdkClientException.Note the creation of a
ResettableInputStream
would entail physically opening a file. If the opened file is meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release method must not be called while the execution is made in other stack frames. In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the stream would need to explicitly disable the accidental closing viaReleasableInputStream.disableClose()
, so that the release method becomes the only way to truly close the opened file. -
newResettableInputStream
Convenient factory method to construct a new resettable input stream for the given file, converting any IOException into SdkClientException with the given error message.Note the creation of a
ResettableInputStream
would entail physically opening a file. If the opened file is meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release method must not be called while the execution is made in other stack frames. In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the stream would need to explicitly disable the accidental closing viaReleasableInputStream.disableClose()
, so that the release method becomes the only way to truly close the opened file. -
newResettableInputStream
Convenient factory method to construct a new resettable input stream for the given file input stream, converting any IOException into SdkClientException.Note the creation of a
ResettableInputStream
would entail physically opening a file. If the opened file is meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release method must not be called while the execution is made in other stack frames. In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the stream would need to explicitly disable the accidental closing viaReleasableInputStream.disableClose()
, so that the release method becomes the only way to truly close the opened file. -
newResettableInputStream
Convenient factory method to construct a new resettable input stream for the given file input stream, converting any IOException into SdkClientException with the given error message.Note the creation of a
ResettableInputStream
would entail physically opening a file. If the opened file is meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release method must not be called while the execution is made in other stack frames. In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the stream would need to explicitly disable the accidental closing viaReleasableInputStream.disableClose()
, so that the release method becomes the only way to truly close the opened file. -
markSupported
public final boolean markSupported()- Overrides:
markSupported
in classSdkFilterInputStream
-
mark
public void mark(int ignored) Marks the current position in this input stream. A subsequent call to thereset
method repositions this stream at the last marked position so that subsequent reads re-read the same bytes. This method works as long as the underlying file has not been closed.Note the creation of a
ResettableInputStream
would entail physically opening a file. If the opened file is meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release method must not be called while the execution is made in other stack frames. In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the stream would need to explicitly disable the accidental closing viaReleasableInputStream.disableClose()
, so that the release method becomes the only way to truly close the opened file.- Overrides:
mark
in classSdkFilterInputStream
- Parameters:
ignored
- ignored
-
reset
Repositions this stream to the position at the time themark
method was last called on this input stream. This method works as long as the underlying file has not been closed.Note the creation of a
ResettableInputStream
would entail physically opening a file. If the opened file is meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release method must not be called while the execution is made in other stack frames. In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the stream would need to explicitly disable the accidental closing viaReleasableInputStream.disableClose()
, so that the release method becomes the only way to truly close the opened file.- Overrides:
reset
in classSdkFilterInputStream
- Throws:
IOException
-
available
- Overrides:
available
in classSdkFilterInputStream
- Throws:
IOException
-
read
- Overrides:
read
in classSdkFilterInputStream
- Throws:
IOException
-
skip
- Overrides:
skip
in classSdkFilterInputStream
- Throws:
IOException
-
read
- Overrides:
read
in classSdkFilterInputStream
- Throws:
IOException
-
getFile
Returns the underlying file, if known; or null if not;
-