Package com.google.common.io

Class MoreFiles.PathByteSource

  • Enclosing class:
    MoreFiles
    private static final class MoreFiles.PathByteSource
extends ByteSource

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.nio.file.LinkOption[] FOLLOW_LINKS  
      private boolean followLinks  
      private java.nio.file.OpenOption[] options  
      private java.nio.file.Path path  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private PathByteSource​(java.nio.file.Path path, java.nio.file.OpenOption... options)  

    • Field Detail

      • FOLLOW_LINKS

        private static final java.nio.file.LinkOption[] FOLLOW_LINKS

      • path

        private final java.nio.file.Path path

      • options

        private final java.nio.file.OpenOption[] options

      • followLinks

        private final boolean followLinks

    • Constructor Detail

      • PathByteSource

        private PathByteSource​(java.nio.file.Path path,
                       java.nio.file.OpenOption... options)

    • Method Detail

      • followLinks

        private static boolean followLinks​(java.nio.file.OpenOption[] options)

      • openStream

        public java.io.InputStream openStream()
                               throws java.io.IOException
        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
        Throws:
        java.io.IOException - if an I/O error occurs while opening the stream

      • readAttributes

        private java.nio.file.attribute.BasicFileAttributes readAttributes()
                                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • sizeIfKnown

        public Optional<java.lang.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

      • size

        public long size()
          throws java.io.IOException
        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
        Throws:
        java.io.IOException - if an I/O error occurs while reading the size of this source

      • read

        public byte[] read()
            throws java.io.IOException
        Description copied from class: ByteSource
        Reads the full contents of this byte source as a byte array.
        Overrides:
        read in class ByteSource
        Throws:
        java.io.IOException - if an I/O error occurs while reading from this source

      • asCharSource

        public CharSource asCharSource​(java.nio.charset.Charset charset)
        Description copied from class: ByteSource
        Returns a CharSource view of this byte source that decodes bytes read from this source as characters using the given Charset.

        If CharSource.asByteSource(java.nio.charset.Charset) is called on the returned source with the same charset, the default implementation of this method will ensure that the original ByteSource is returned, rather than round-trip encoding. Subclasses that override this method should behave the same way.

        Overrides:
        asCharSource in class ByteSource

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object