Package io.microsphere.io

Class IOUtils

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int BUFFER_SIZE
      The buffer size for I/O
      static int DEFAULT_BUFFER_SIZE
      The default buffer size for I/O

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void close​(java.io.Closeable closeable)
      Unconditionally close a Closeable.
      static int copy​(java.io.InputStream in, java.io.OutputStream out)
      Copy the contents of the given InputStream to the given OutputStream.
      static int copy​(java.io.Reader reader, java.io.Writer writer)
      Copy the contents of the given Reader to the given Writer.
      static java.lang.String copyToString​(java.io.InputStream in)
      Copy the contents of the given InputStream into a new String using CharsetUtils.DEFAULT_CHARSET.
      static java.lang.String copyToString​(java.io.InputStream in, java.lang.String encoding)
      Copy the contents of the given InputStream into a new String.
      static java.lang.String copyToString​(java.io.InputStream in, java.nio.charset.Charset charset)
      See toString(InputStream, Charset)
      static java.lang.String copyToString​(java.io.Reader reader)
      Copy the contents of the given Reader into a new String.
      static byte[] toByteArray​(java.io.InputStream in)
      Copy the contents of the given InputStream into a new byte array.
      static java.lang.String toString​(java.io.InputStream in)
      copyToString(InputStream) as recommended
      static java.lang.String toString​(java.io.InputStream in, java.lang.String encoding)
      copyToString(InputStream, String) as recommended
      static java.lang.String toString​(java.io.InputStream in, java.nio.charset.Charset charset)
      copyToString(InputStream, Charset) as recommended
      static java.lang.String toString​(java.io.Reader reader)
      copyToString(Reader) as recommended

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • DEFAULT_BUFFER_SIZE

        public static final int DEFAULT_BUFFER_SIZE
        The default buffer size for I/O
        See Also:
        Constant Field Values

      • BUFFER_SIZE

        public static final int BUFFER_SIZE
        The buffer size for I/O

    • Method Detail

      • toByteArray

        public static byte[] toByteArray​(java.io.InputStream in)
                          throws java.io.IOException
        Copy the contents of the given InputStream into a new byte array.

        Leaves the stream open when done.

        Parameters:
        in - the stream to copy from (may be null or empty)
        Returns:
        the new byte array that has been copied to (possibly empty)
        Throws:
        java.io.IOException - in case of I/O errors

      • toString

        public static java.lang.String toString​(java.io.Reader reader)
                                 throws java.io.IOException
        copyToString(Reader) as recommended
        Throws:
        java.io.IOException
        See Also:
        copyToString(Reader)

      • copyToString

        public static java.lang.String copyToString​(java.io.InputStream in,
                                            java.lang.String encoding)
                                     throws java.io.IOException
        Copy the contents of the given InputStream into a new String.

        Leaves the stream open when done.

        Parameters:
        in - the stream to copy from (may be null or empty)
        encoding - the encoding to use, if it's null, take the SystemUtils.FILE_ENCODING as default
        Returns:
        the new byte array that has been copied to (possibly empty)
        Throws:
        java.io.IOException - in case of I/O errors

      • copyToString

        public static java.lang.String copyToString​(java.io.InputStream in)
                                     throws java.io.IOException
        Copy the contents of the given InputStream into a new String using CharsetUtils.DEFAULT_CHARSET.

        Leaves the stream open when done.

        Parameters:
        in - the stream to copy from (may be null or empty)
        Returns:
        the new byte array that has been copied to (possibly empty)
        Throws:
        java.io.IOException - in case of I/O errors

      • copyToString

        public static java.lang.String copyToString​(java.io.InputStream in,
                                            java.nio.charset.Charset charset)
                                     throws java.io.IOException
        See toString(InputStream, Charset)
        Throws:
        java.io.IOException

      • copyToString

        public static java.lang.String copyToString​(java.io.Reader reader)
                                     throws java.io.IOException
        Copy the contents of the given Reader into a new String.

        Leaves the Reader open when done.

        Parameters:
        reader - the Reader to copy from (may be null or empty)
        Returns:
        the new String that has been copied to (possibly empty)
        Throws:
        java.io.IOException - in case of I/O errors

      • copy

        public static int copy​(java.io.InputStream in,
                       java.io.OutputStream out)
                throws java.io.IOException
        Copy the contents of the given InputStream to the given OutputStream.

        Leaves both streams open when done.

        Parameters:
        in - the InputStream to copy from
        out - the OutputStream to copy to
        Returns:
        the number of bytes copied
        Throws:
        java.io.IOException - in case of I/O errors

      • copy

        public static int copy​(java.io.Reader reader,
                       java.io.Writer writer)
                throws java.io.IOException
        Copy the contents of the given Reader to the given Writer.

        Leaves both streams open when done.

        Parameters:
        reader - the Reader to copy from
        writer - the Writer to copy to
        Returns:
        the number of chars copied
        Throws:
        java.io.IOException - in case of I/O errors

      • close

        public static void close​(java.io.Closeable closeable)
        Unconditionally close a Closeable.

        Equivalent to Closeable.close(), except any exceptions will be ignored. This is typically used in finally blocks.

        Example code: 

           Closeable closeable = null;
   try {
       closeable = new FileReader("foo.txt");
       // process closeable
       closeable.close();
   } catch (Exception e) {
       // error handling
   } finally {
       IOUtils.closeQuietly(closeable);
   }
        Parameters:
        closeable - the object to close, may be null or already closed