Package oracle.dbtools.plugin.api.io

Interface IOStreams

public interface IOStreams
Methods for working with InputStream, OutputStream, Readable, and Appendable streams.
Author:
cdivilly

  • Method Details

    • copy

      long copy<wbr>(InputStream is, OutputStream os) throws IOException
      Copy the contents of a InputStream to an OutputStream
      Parameters:
      is - The stream containing the content
      os - The stream to write the content to
      Returns:
      The number of bytes copied
      Throws:
      IOException - if an error occurs while reading/writing either stream

    • copy

      long copy<wbr>(Readable source, Appendable destination) throws IOException
      Copy the contents of a Readable (input character stream) to an Appendable (output character stream)
      Parameters:
      source - The stream containing the content
      destination - The stream to write the content to
      Returns:
      The number of characters copied
      Throws:
      IOException - if an error occurs while reading/writing either stream

    • copy

      long copy<wbr>(ReadableByteChannel source, WritableByteChannel destination) throws IOException
      Copy the contents of a ReadableByteChannel (input byte stream) to a WritableByteChannel (output byte stream)
      Parameters:
      source - The stream containing the content
      destination - The stream to write the content to
      Returns:
      The number of bytes copied
      Throws:
      IOException - if an error occurs while reading/writing either stream

    • emptyStream

      InputStream emptyStream()
      Return an InputStream containing zero bytes
      Returns:
      an empty stream

    • nullStream

      OutputStream nullStream()
      Return an OutputStream that swallows all output silently
      Returns:
      A null output stream

    • uncloseable

      InputStream uncloseable<wbr>(InputStream in)
      Wrapper an InputStream so it cannot be closed.
      Parameters:
      in - InputStream instance
      Returns:
      InputStream instance that cannot be closed.

    • isEmptyStream

      boolean isEmptyStream<wbr>(InputStream stream)
      Checks if the specified InputStream is the empty stream instance provided by emptyStream().
      Parameters:
      stream - The stream to be tested
      Returns:
      true if the specified InputStream is the same instance, false otherwise.

    • asString

      String asString<wbr>(InputStream is) throws IOException
      Buffer the contents of the specified byte stream into a String. The contents of the byte stream must be encoded in UTF-8.
      Parameters:
      is - The byte stream
      Returns:
      The buffered stream as a String
      Throws:
      IOException - if an error occurs while reading the stream

    • asString

      String asString<wbr>(Readable r) throws IOException
      Buffer the contents of the specified character stream into a String .
      Parameters:
      r - The character stream
      Returns:
      The buffered stream as a String
      Throws:
      IOException - if an error occurs while reading the stream

    • asStringReadByLine

      String asStringReadByLine<wbr>(BufferedReader r) throws IOException
      Reads the contents of the specified character input stream into a String. This method receives a BufferedReader, which is a more efficient way to read characters from the stream line by line. It is advisable to wrap a BufferedReader around any Reader whose read() operations may be costly.
      Parameters:
      r - The character stream
      Returns:
      The buffered stream as a String
      Throws:
      IOException - if an error occurs while reading the stream

    • asInputStream

      InputStream asInputStream<wbr>(CharSequence text) throws IOException
      Convert a CharSequence into an InputStream instance
      Parameters:
      text - The text to be transformed into an InputStream
      Returns:
      InputStream instance
      Throws:
      IOException - if an error occurs while reading the stream

    • asInputStream

      InputStream asInputStream<wbr>(byte[] bytes)
      Adapt the specified byte array to an instance of InputStream.
      Parameters:
      bytes - The bytes to be exposed as a stream
      Returns:
      The InputStream instance.

    • asByteChannel

      SeekableByteChannel asByteChannel<wbr>(byte[] bytes)
      Adapt the specified byte array to a read only instance of SeekableByteChannel. Note that the SeekableByteChannel.write(java.nio.ByteBuffer) and SeekableByteChannel.truncate(long) methods of the returned instance will always throw NonWritableChannelException. The returned instance is not thread safe, the SeekableByteChannel.position() state is not multi-thread safe.
      Parameters:
      bytes - The bytes to be exposed as a byte channel
      Returns:
      read only SeekableByteChannel instance

    • asByteArray

      byte[] asByteArray<wbr>(InputStream is) throws IOException
      buffer the contents of the specified byte stream into a byte[] array.
      Parameters:
      is - The byte stream
      Returns:
      byte[] buffer containing the entire contents of the stream
      Throws:
      IOException - if an error occurs while reading the stream

    • asByteArray

      byte[] asByteArray<wbr>(Readable r) throws IOException
      Buffer the contents of the specified Readable into a byte[] array
      Parameters:
      r - The character stream
      Returns:
      byte[] buffer containing the entire contents of the stream
      Throws:
      IOException - if an error occurs while reading the stream

    • asByteArray

      byte[] asByteArray<wbr>(CharSequence text) throws IOException
      Convert the specified text into a UTF-8 encoded byte[] array.
      Parameters:
      text - The text to be converted
      Returns:
      byte[] buffer containing the UTF-8 representation of the text
      Throws:
      IOException - if an error occurs while reading the stream

    • asByteArray

      byte[] asByteArray<wbr>(ReadableByteChannel r) throws IOException
      Buffer the contents of the specified ReadableByteChannel into a byte[] array
      Parameters:
      r - The byte channel
      Returns:
      byte[] buffer containing the entire contents of the stream
      Throws:
      IOException - if an error occurs while reading the stream