Class ByteSource.ByteArrayByteSource

java.lang.Object
com.google.common.io.ByteSource
com.google.common.io.ByteSource.ByteArrayByteSource
Direct Known Subclasses:
ByteSource.EmptyByteSource
Enclosing class:
ByteSource

private static class ByteSource.ByteArrayByteSource extends ByteSource
  • Field Details

    • bytes

      final byte[] bytes
    • offset

      final int offset
    • length

      final int length
  • Constructor Details

    • ByteArrayByteSource

      ByteArrayByteSource(byte[] bytes)
    • ByteArrayByteSource

      ByteArrayByteSource(byte[] bytes, int offset, int length)
  • Method Details

    • openStream

      public InputStream openStream()
      Description copied from class: ByteSource
      Opens a new InputStream 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 class ByteSource
    • openBufferedStream

      public InputStream openBufferedStream()
      Description copied from class: ByteSource
      Opens a new buffered InputStream for reading from this source. The returned stream is not required to be a BufferedInputStream in order to allow implementations to simply delegate to ByteSource.openStream() when the stream returned by that method does not benefit from additional buffering (for example, a ByteArrayInputStream). 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 class ByteSource
    • isEmpty

      public boolean isEmpty()
      Description copied from class: ByteSource
      Returns whether the source has zero bytes. The default implementation first checks ByteSource.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 return true from isEmpty() despite having readable content.

      Overrides:
      isEmpty in class ByteSource
    • size

      public long size()
      Description copied from class: ByteSource
      Returns the size of this source in bytes, even if doing so requires opening and traversing an entire stream. To avoid a potentially expensive operation, see ByteSource.sizeIfKnown().

      The default implementation calls ByteSource.sizeIfKnown() and returns the value if present. If absent, it will fall back to a heavyweight operation that will open a stream, read (or skip, if possible) to the end of the stream and return the total number of bytes that were read.

      Note that for some sources that implement ByteSource.sizeIfKnown() to provide a more efficient implementation, 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).

      In either case, for mutable sources such as files, a subsequent read may return a different number of bytes if the contents are changed.

      Overrides:
      size in class ByteSource
    • sizeIfKnown

      public Optional<Long> 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 class ByteSource
    • read

      public byte[] read()
      Description copied from class: ByteSource
      Reads the full contents of this byte source as a byte array.
      Overrides:
      read in class ByteSource
    • read

      public <T> T read(ByteProcessor<T> processor) throws IOException
      Description copied from class: ByteSource
      Reads the contents of this byte source using the given processor to process bytes as they are read. Stops when all bytes have been read or the consumer returns false. Returns the result produced by the processor.
      Overrides:
      read in class ByteSource
      Throws:
      IOException - if an I/O error occurs while reading from this source or if processor throws an IOException
    • copyTo

      public long copyTo(OutputStream output) throws IOException
      Description copied from class: ByteSource
      Copies the contents of this byte source to the given OutputStream. Does not close output.
      Overrides:
      copyTo in class ByteSource
      Returns:
      the number of bytes copied
      Throws:
      IOException - if an I/O error occurs while reading from this source or writing to output
    • hash

      public HashCode hash(HashFunction hashFunction) throws IOException
      Description copied from class: ByteSource
      Hashes the contents of this byte source using the given hash function.
      Overrides:
      hash in class ByteSource
      Throws:
      IOException - if an I/O error occurs while reading from this source
    • slice

      public ByteSource slice(long offset, long length)
      Description copied from class: ByteSource
      Returns a view of a slice of this byte source that is at most length bytes long starting at the given offset. If offset is greater than the size of this source, the returned source will be empty. If offset + length is greater than the size of this source, the returned source will contain the slice starting at offset and ending at the end of this source.
      Overrides:
      slice in class ByteSource
    • toString

      public String toString()
      Overrides:
      toString in class Object