Class ByteSource.SlicedByteSource
- Enclosing class:
ByteSource
-
Nested Class Summary
Nested classes/interfaces inherited from class com.google.common.io.ByteSource
ByteSource.AsCharSource
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
isEmpty()
Returns whether the source has zero bytes.Opens a new bufferedInputStream
for reading from this source.Opens a newInputStream
for reading from this source.Returns the size of this source in bytes, if the size can be easily determined without actually opening the data stream.slice
(long offset, long length) Returns a view of a slice of this byte source that is at mostlength
bytes long starting at the givenoffset
.private InputStream
toString()
Methods inherited from class com.google.common.io.ByteSource
asCharSource, concat, concat, concat, contentEquals, copyTo, copyTo, empty, hash, read, read, size, wrap
-
Field Details
-
offset
final long offset -
length
final long length
-
-
Constructor Details
-
SlicedByteSource
SlicedByteSource(long offset, long length)
-
-
Method Details
-
openStream
Description copied from class:ByteSource
Opens a newInputStream
for reading from this source. This method returns a new, independent stream each time it is called.The caller is responsible for ensuring that the returned stream is closed.
- Specified by:
openStream
in classByteSource
- Throws:
IOException
- if an I/O error occurs while opening the stream
-
openBufferedStream
Description copied from class:ByteSource
Opens a new bufferedInputStream
for reading from this source. The returned stream is not required to be aBufferedInputStream
in order to allow implementations to simply delegate toByteSource.openStream()
when the stream returned by that method does not benefit from additional buffering (for example, aByteArrayInputStream
). This method returns a new, independent stream each time it is called.The caller is responsible for ensuring that the returned stream is closed.
- Overrides:
openBufferedStream
in classByteSource
- Throws:
IOException
- if an I/O error occurs while opening the stream
-
sliceStream
- Throws:
IOException
-
slice
Description copied from class:ByteSource
Returns a view of a slice of this byte source that is at mostlength
bytes long starting at the givenoffset
. Ifoffset
is greater than the size of this source, the returned source will be empty. Ifoffset + length
is greater than the size of this source, the returned source will contain the slice starting atoffset
and ending at the end of this source.- Overrides:
slice
in classByteSource
-
isEmpty
Description copied from class:ByteSource
Returns whether the source has zero bytes. The default implementation first checksByteSource.sizeIfKnown()
, returning true if it's known to be zero and false if it's known to be non-zero. If the size is not known, it falls back to opening a stream and checking for EOF.Note that, in cases where
sizeIfKnown
returns zero, it is possible that bytes are actually available for reading. (For example, some special files may return a size of 0 despite actually having content when read.) This means that a source may returntrue
fromisEmpty()
despite having readable content.- Overrides:
isEmpty
in classByteSource
- Throws:
IOException
- if an I/O error occurs
-
sizeIfKnown
Description copied from class:ByteSource
Returns the size of this source in bytes, if the size can be easily determined without actually opening the data stream.The default implementation returns
Optional.absent()
. Some sources, such as a file, may return a non-absent value. Note that in such cases, it is possible that this method will return a different number of bytes than would be returned by reading all of the bytes (for example, some special files may return a size of 0 despite actually having content when read).Additionally, for mutable sources such as files, a subsequent read may return a different number of bytes if the contents are changed.
- Overrides:
sizeIfKnown
in classByteSource
-
toString
-