StreamUtils (bus-all 5.6.2 API)

java.lang.Object
- org.aoju.bus.core.utils.StreamUtils

```
public class StreamUtils
extends Object
```
Since:

JDK 1.8+

Version:

5.6.2

Author:

Kimi Liu

Constructor Summary

Constructors
Constructor and Description

StreamUtils()

Constructors
Constructor and Description
`StreamUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`appendWriteAndClose(File f, String text)`
`static BufferedInputStream`	`buff(InputStream ins)` 为一个输入流包裹一个缓冲流如果这个输入流本身就是缓冲流,则直接返回
`static BufferedOutputStream`	`buff(OutputStream ops)` 为一个输出流包裹一个缓冲流如果这个输出流本身就是缓冲流,则直接返回
`static BufferedReader`	`buff(Reader reader)` 为一个文本输入流包裹一个缓冲流如果这个输入流本身就是缓冲流,则直接返回
`static BufferedWriter`	`buff(Writer writer)` 为一个文本输出流包裹一个缓冲流如果这个文本输出流本身就是缓冲流,则直接返回
`static void`	`copy(InputStream in, OutputStream out)`
`static void`	`copy(InputStream in, OutputStream out, byte[] buf)`
`static void`	`copy(InputStream in, OutputStream out, int len)`
`static void`	`copy(InputStream in, OutputStream out, int len, byte[] buf)`
`static void`	`copy(InputStream in, OutputStream out, int len, int swapBytes)`
`static void`	`copy(InputStream in, OutputStream out, int len, int swapBytes, byte[] buf)`
`static boolean`	`equals(InputStream ina, InputStream inb)` 判断两个输入流是否严格相等
`static OutputStream`	`fileOut(File file)` 根据一个文件建立一个输出流
`static InputStream`	`findFileAsStream(String path, Class<?> klass, String enc)` 获取输出流
`static void`	`io(Reader in, Writer out, int bufferSize)`
`static String`	`nextLineTrim(BufferedReader br)`
`static InputStream`	`openFileOrURL(String name)`
`static byte[]`	`read(InputStream ins)` 读取一个输入流中所有的字节
`static StringBuilder`	`read(Reader reader)` 从一个文本流中读取全部内容并返回
`static int`	`read(Reader reader, StringBuilder sb)` 从一个文本流中读取全部内容并写入缓冲
`static String`	`readAll(Reader reader)` 从一个文本输入流读取所有内容,并将该流关闭
`static byte[]`	`readAndClose(InputStream ins)` 读取一个输入流中所有的字节,并关闭输入流
`static int`	`readAndClose(InputStreamReader reader, StringBuilder sb)` 从一个文本流中读取全部内容并写入缓冲
`static String`	`readAndClose(Reader reader)` 从一个文本流中读取全部内容并返回
`static int`	`readAvailable(InputStream in, byte[] b, int off, int len)`
`static void`	`readFully(InputStream in, byte[] b, int off, int len)`
`static String`	`readText(InputStream in)`
`static String`	`readText(InputStream in, String encoding)`
`static String`	`readText(InputStream in, String encoding, int bufferSize)`
`static String`	`readText(Reader reader)`
`static String`	`readText(Reader reader, int bufferSize)`
`static boolean`	`safeClose(Closeable cb)` 关闭一个可关闭对象,可以接受 null 如果成功关闭,返回 true,发生异常返回 false
`static void`	`safeFlush(Flushable fa)` 安全刷新一个可刷新的对象,可接受 null
`static void`	`skipFully(InputStream in, long n)`
`static InputStream`	`utf8filte(InputStream in)` 判断并移除UTF-8的BOM头
`static Reader`	`utf8r(InputStream is)`
`static Writer`	`utf8w(OutputStream os)`
`static InputStream`	`wrap(byte[] bytes)`
`static void`	`write(OutputStream ops, byte[] bytes)` 将一个字节数组写入一个输出流
`static long`	`write(OutputStream ops, InputStream ins)` 将输入流写入一个输出流块大小为 8192
`static long`	`write(OutputStream ops, InputStream ins, int bufferSize)` 将输入流写入一个输出流
`static void`	`write(Writer writer, CharSequence cs)` 将一段文本全部写入一个writer
`static long`	`write(Writer writer, Reader reader)` 将文本输入流写入一个文本输出流块大小为 8192
`static void`	`writeAndClose(OutputStream ops, byte[] bytes)` 将一个字节数组写入一个输出流
`static long`	`writeAndClose(OutputStream ops, InputStream ins)` 将输入流写入一个输出流块大小为 8192
`static long`	`writeAndClose(OutputStream ops, InputStream ins, int buf)`
`static void`	`writeAndClose(Writer writer, CharSequence cs)` 将一段文本全部写入一个writer
`static long`	`writeAndClose(Writer writer, Reader reader)` 将文本输入流写入一个文本输出流块大小为 8192

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- StreamUtils
```
public StreamUtils()
```

Method Detail

equals

public static boolean equals(InputStream ina,
                             InputStream inb)
                      throws IOException

判断两个输入流是否严格相等

Parameters:: ina - 输入流; inb - 输入流
Returns:: the boolean
Throws:: IOException - 异常

read
```
public static StringBuilder read(Reader reader)
                          throws IOException
```
从一个文本流中读取全部内容并返回
注意,它并不会关闭输出流

Parameters:

reader - 文本输出流

Returns:

文本内容

Throws:

IOException - 异常

read
```
public static byte[] read(InputStream ins)
                   throws IOException
```
读取一个输入流中所有的字节

Parameters:

ins - 输入流,必须支持 available()

Returns:

一个字节数组

Throws:

IOException - 异常

read
```
public static int read(Reader reader,
                       StringBuilder sb)
                throws IOException
```
从一个文本流中读取全部内容并写入缓冲

Parameters:

reader - 文本输出流

sb - 输出的文本缓冲

Returns:

读取的字符数量

Throws:

IOException - 异常

readAll
```
public static String readAll(Reader reader)
```
从一个文本输入流读取所有内容,并将该流关闭

Parameters:

reader - 文本输入流

Returns:

输入流所有内容

readText

public static String readText(InputStream in)
                       throws IOException

Throws:: IOException

readText

public static String readText(InputStream in,
                              String encoding)
                       throws IOException

Throws:: IOException

readText

public static String readText(InputStream in,
                              String encoding,
                              int bufferSize)
                       throws IOException

Throws:: IOException

readText

public static String readText(Reader reader)
                       throws IOException

Throws:: IOException

readText

public static String readText(Reader reader,
                              int bufferSize)
                       throws IOException

Throws:: IOException

write

public static void write(Writer writer,
                         CharSequence cs)
                  throws IOException

将一段文本全部写入一个writer

注意,它并不会关闭输出流

Parameters:: writer - 操作器; cs - 文本
Throws:: IOException - 异常

write
```
public static long write(OutputStream ops,
                         InputStream ins)
                  throws IOException
```
将输入流写入一个输出流块大小为 8192
注意,它并不会关闭输入/出流

Parameters:

ops - 输出流

ins - 输入流

Returns:

写入的字节数

Throws:

IOException - 异常

write

public static long write(OutputStream ops,
                         InputStream ins,
                         int bufferSize)
                  throws IOException

将输入流写入一个输出流

注意,它并不会关闭输入/出流

Parameters:: ops - 输出流; ins - 输入流; bufferSize - 缓冲块大小
Returns:: 写入的字节数
Throws:: IOException - 异常

write
```
public static long write(Writer writer,
                         Reader reader)
                  throws IOException
```
将文本输入流写入一个文本输出流块大小为 8192
注意,它并不会关闭输入/出流

Parameters:

writer - 输出流

reader - 输入流

Returns:

the long

Throws:

IOException - 异常

write
```
public static void write(OutputStream ops,
                         byte[] bytes)
                  throws IOException
```
将一个字节数组写入一个输出流
注意,它并不会关闭输出流

Parameters:

ops - 输出流

bytes - 字节数组

Throws:

IOException - 异常

readAndClose
```
public static String readAndClose(Reader reader)
```
从一个文本流中读取全部内容并返回

Parameters:

reader - 文本输入流

Returns:

文本内容

readAndClose
```
public static byte[] readAndClose(InputStream ins)
```
读取一个输入流中所有的字节,并关闭输入流

Parameters:

ins - 输入流,必须支持 available()

Returns:

一个字节数组

readAndClose
```
public static int readAndClose(InputStreamReader reader,
                               StringBuilder sb)
```
从一个文本流中读取全部内容并写入缓冲
注意,它会关闭输出流

Parameters:

reader - 文本输出流

sb - 输出的文本缓冲

Returns:

读取的字符数量

writeAndClose

public static void writeAndClose(Writer writer,
                                 CharSequence cs)

将一段文本全部写入一个writer

注意,它会关闭输出流

Parameters:: writer - 输出流; cs - 文本

writeAndClose
```
public static long writeAndClose(OutputStream ops,
                                 InputStream ins)
```
将输入流写入一个输出流块大小为 8192
注意,它会关闭输入/出流

Parameters:

ops - 输出流

ins - 输入流

Returns:

写入的字节数

writeAndClose
```
public static long writeAndClose(Writer writer,
                                 Reader reader)
```
将文本输入流写入一个文本输出流块大小为 8192
注意,它会关闭输入/出流

Parameters:

writer - 输出流

reader - 输入流

Returns:

the long

writeAndClose
```
public static void writeAndClose(OutputStream ops,
                                 byte[] bytes)
```
将一个字节数组写入一个输出流
注意,它会关闭输出流

Parameters:

ops - 输出流

bytes - 字节数组

writeAndClose

public static long writeAndClose(OutputStream ops,
                                 InputStream ins,
                                 int buf)

buff
```
public static BufferedReader buff(Reader reader)
```
为一个文本输入流包裹一个缓冲流如果这个输入流本身就是缓冲流,则直接返回

Parameters:

reader - 文本输入流

Returns:

缓冲文本输入流

buff
```
public static BufferedWriter buff(Writer writer)
```
为一个文本输出流包裹一个缓冲流如果这个文本输出流本身就是缓冲流,则直接返回

Parameters:

writer - 文本输出流

Returns:

缓冲文本输出流

buff
```
public static BufferedInputStream buff(InputStream ins)
```
为一个输入流包裹一个缓冲流如果这个输入流本身就是缓冲流,则直接返回

Parameters:

ins - 输入流

Returns:

缓冲输入流

buff
```
public static BufferedOutputStream buff(OutputStream ops)
```
为一个输出流包裹一个缓冲流如果这个输出流本身就是缓冲流,则直接返回

Parameters:

ops - 输出流

Returns:

缓冲输出流

readFully

public static void readFully(InputStream in,
                             byte[] b,
                             int off,
                             int len)
                      throws IOException

Throws:: IOException

skipFully

public static void skipFully(InputStream in,
                             long n)
                      throws IOException

Throws:: IOException

safeClose
```
public static boolean safeClose(Closeable cb)
```
关闭一个可关闭对象,可以接受 null 如果成功关闭,返回 true,发生异常返回 false

Parameters:

cb - 可关闭对象

Returns:

是否成功关闭

safeFlush
```
public static void safeFlush(Flushable fa)
```
安全刷新一个可刷新的对象,可接受 null

Parameters:

fa - 可刷新对象

utf8r

public static Reader utf8r(InputStream is)

utf8w

public static Writer utf8w(OutputStream os)

utf8filte
```
public static InputStream utf8filte(InputStream in)
```
判断并移除UTF-8的BOM头

Parameters:

in - 输入流

Returns:

输入流

fileOut
```
public static OutputStream fileOut(File file)
```
根据一个文件建立一个输出流

Parameters:

file - 文件

Returns:

输出流

wrap

public static InputStream wrap(byte[] bytes)

appendWriteAndClose

public static void appendWriteAndClose(File f,
                                       String text)

findFileAsStream

public static InputStream findFileAsStream(String path,
                                           Class<?> klass,
                                           String enc)

获取输出流

Parameters:: path - 文件路径; klass - 参考的类, -- 会用这个类的 ClassLoader; enc - 文件路径编码
Returns:: 输出流

readAvailable

public static int readAvailable(InputStream in,
                                byte[] b,
                                int off,
                                int len)
                         throws IOException

Throws:: IOException

nextLineTrim

public static String nextLineTrim(BufferedReader br)
                           throws IOException

Throws:: IOException

copy

public static void copy(InputStream in,
                        OutputStream out,
                        byte[] buf)
                 throws IOException

Throws:: IOException

copy

public static void copy(InputStream in,
                        OutputStream out)
                 throws IOException

Throws:: IOException

copy

public static void copy(InputStream in,
                        OutputStream out,
                        int len,
                        byte[] buf)
                 throws IOException

Throws:: IOException

copy

public static void copy(InputStream in,
                        OutputStream out,
                        int len)
                 throws IOException

Throws:: IOException

copy

public static void copy(InputStream in,
                        OutputStream out,
                        int len,
                        int swapBytes,
                        byte[] buf)
                 throws IOException

Throws:: IOException

copy

public static void copy(InputStream in,
                        OutputStream out,
                        int len,
                        int swapBytes)
                 throws IOException

Throws:: IOException

openFileOrURL

public static InputStream openFileOrURL(String name)
                                 throws IOException

Throws:: IOException

io

public static void io(Reader in,
                      Writer out,
                      int bufferSize)
               throws IOException

Throws:: IOException

Class StreamUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StreamUtils

Method Detail

equals

read

read

read

readAll

readText

readText

readText

readText

readText

write

write

write

write

write

readAndClose

readAndClose

readAndClose

writeAndClose

writeAndClose

writeAndClose

writeAndClose

writeAndClose

buff

buff

buff

buff

readFully

skipFully

safeClose

safeFlush

utf8r

utf8w

utf8filte

fileOut

wrap

appendWriteAndClose

findFileAsStream

readAvailable

nextLineTrim

copy

copy

copy

copy

copy

copy

openFileOrURL

io