com.github.dm.jrt.core

Class ByteChannel.BufferOutputStream

java.lang.Object

java.io.OutputStream

com.github.dm.jrt.core.ByteChannel.BufferOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Enclosing class:

ByteChannel

public abstract static class ByteChannel.BufferOutputStream
extends OutputStream

Output stream used to write data into the buffer channel.

Constructor Summary

Constructors

Constructor and Description
ByteChannel.BufferOutputStream()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close()
abstract void	flush()
abstract int	write(InputStream in) Writes some bytes into the output stream by reading them from the specified input stream.
long	writeAll(InputStream in) Writes all the returned bytes into the output stream by reading them from the specified input stream. Calling this method has the same effect as calling:

Methods inherited from class java.io.OutputStream

write, write, write

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ByteChannel.BufferOutputStream

public ByteChannel.BufferOutputStream()

Method Detail

write

public abstract int write(@NotNull
        InputStream in)
                   throws IOException

Writes some bytes into the output stream by reading them from the specified input stream.

Parameters:

in - the input stream.

Returns:

the total number of bytes written into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

IOException - If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

writeAll

public long writeAll(@NotNull
            InputStream in)
              throws IOException

Writes all the returned bytes into the output stream by reading them from the specified input stream.
Calling this method has the same effect as calling:

     

         while (outputStream.write(inputStream) > 0) {

             // Keep looping
         }
     
 

Parameters:

in - the input stream.

Returns:

the total number of bytes written.

Throws:

IOException - If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

flush

public abstract void flush()

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

close

public abstract void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream