Module 

Interface StreamSinkChannel

    • Method Detail

      • transferFrom

        long transferFrom​(java.nio.channels.FileChannel src,
                          long position,
                          long count)
                   throws java.io.IOException
        Transfer bytes into this channel from the given file. Using this method in preference to FileChannel.transferTo(long, long, WritableByteChannel) may provide a performance advantage on some platforms.

        If the current thread is interrupted when this method is called, it may throw a InterruptedIOException; however, if this exception is thrown, the InterruptedIOException.bytesTransferred field is guaranteed to be 0.

        Parameters:
        src - the file to read from
        position - the position within the file from which the transfer is to begin
        count - the number of bytes to be transferred
        Returns:
        the number of bytes (possibly 0) that were actually transferred
        Throws:
        java.io.IOException - if an I/O error occurs
      • transferFrom

        long transferFrom​(StreamSourceChannel source,
                          long count,
                          java.nio.ByteBuffer throughBuffer)
                   throws java.io.IOException
        Transfers bytes from the given channel source. On some platforms, this may avoid copying bytes between user and kernel space. On other platforms, bytes are passed through the throughBuffer parameter's buffer space. On entry, throughBuffer will be cleared. On exit, the buffer will be flipped for emptying, and may be empty or may contain data. If this method returns a value less than count, then the remaining data in throughBuffer may contain data read from source which must be written to this channel to complete the operation. Note that using a direct buffer may provide an intermediate performance gain on platforms without zero-copy facilities.

        If the current thread is interrupted when this method is called, it may throw a InterruptedIOException; however, if this exception is thrown, the InterruptedIOException.bytesTransferred field is guaranteed to be 0.

        Parameters:
        source - the source to read from
        count - the number of bytes to be transferred
        throughBuffer - the buffer to copy through.
        Returns:
        the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached
        Throws:
        java.io.IOException - if an I/O error occurs
      • writeFinal

        int writeFinal​(java.nio.ByteBuffer src)
                throws java.io.IOException
        Writes some data to the channel, with the same semantics as WritableByteChannel.write(java.nio.ByteBuffer). If all the data is written out then the channel will have its writes shutdown. Semantically this method is equivalent to: int rem = src.remaining(); int written = channel.write(src); if(written == rem) { channel.shutdownWrites() } If an exception is thrown the caller is still responsible for closing the channel.
        Parameters:
        src - The data to write
        Returns:
        The amount of data that was actually written.
        Throws:
        java.io.IOException
        See Also:
        WritableByteChannel.write(java.nio.ByteBuffer), SuspendableWriteChannel.shutdownWrites()
      • writeFinal

        long writeFinal​(java.nio.ByteBuffer[] srcs,
                        int offset,
                        int length)
                 throws java.io.IOException
        Writes some data to the channel, with the same semantics as GatheringByteChannel.write(java.nio.ByteBuffer[], int, int). If all the data is written out then the channel will have its writes shutdown. If an exception is thrown the caller is still responsible for closing the channel.
        Parameters:
        srcs - The buffers from which bytes are to be retrieved
        offset - The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than srcs.length
        length - The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset
        Returns:
        The amount of data that was actually written
        Throws:
        java.io.IOException
        See Also:
        GatheringByteChannel.write(java.nio.ByteBuffer[], int, int), SuspendableWriteChannel.shutdownWrites()
      • writeFinal

        long writeFinal​(java.nio.ByteBuffer[] srcs)
                 throws java.io.IOException
        Writes some data to the channel, with the same semantics as GatheringByteChannel.write(java.nio.ByteBuffer[]). If all the data is written out then the channel will have its writes shutdown. If an exception is thrown the caller is still responsible for closing the channel.
        Parameters:
        srcs - The buffers from which bytes are to be retrieved
        Returns:
        The amount of data that was actually written
        Throws:
        java.io.IOException
        See Also:
        GatheringByteChannel.write(java.nio.ByteBuffer[]), SuspendableWriteChannel.shutdownWrites()