java.lang.Object

org.miaixz.bus.core.xyz.IoKit

public class IoKit extends Object

IO工具类 IO工具类只是辅助流的读写，并不负责关闭流。原因是流可能被多次读写，读写关闭后容易造成问题。

Since:: Java 17+
Author:: Kimi Liu

Constructor Summary

Constructors

Constructor

Description

IoKit()
Method Summary

Modifier and Type

Method

Description

static Sink

appendingSink(File file)

返回一个附加到file的接收器

static boolean

arrayRangeEquals(byte[] a, int aOffset, byte[] b, int bOffset, int byteCount)

static Sink

blackhole()

返回一个都不写的接收器

static BufferSink

buffer(Sink sink)

返回一个新接收器，该接收器缓冲写sink 返回的接收器将批量写入sink

static BufferSource

buffer(Source source)

返回缓冲区从source读取的字节流返回的源将对其内存缓冲区执行批量读取

static void

checkOffsetAndCount(long size, long offset, long byteCount)

static void

close(Closeable closeable)

关闭关闭失败不会抛出异常

static void

close(AutoCloseable autoCloseable)

关闭关闭失败不会抛出异常

static void

close(Object obj)

尝试关闭指定对象判断对象如果实现了AutoCloseable，则调用之

static void

close(ServerSocket serverSocket)

static void

close(Socket socket)

关闭关闭失败不会抛出异常

static void

close(AsynchronousSocketChannel channel)

static void

closeQuietly(AutoCloseable... closeables)

按照给定顺序连续关闭一系列对象这些对象必须按照顺序关闭，否则会出错。

static boolean

contentEquals(InputStream input1, InputStream input2)

对比两个流内容是否相同内部会转换流为 BufferedInputStream

static boolean

contentEquals(Reader input1, Reader input2)

对比两个Reader的内容是否一致内部会转换流为 BufferedInputStream

static boolean

contentEqualsIgnoreEOL(Reader input1, Reader input2)

对比两个流内容是否相同，忽略EOL字符内部会转换流为 BufferedInputStream

static long

copy(FileInputStream in, FileOutputStream out)

拷贝文件流，使用NIO

static long

copy(InputStream in, OutputStream out)

拷贝流，使用默认Buffer大小，拷贝后不关闭流

static void

copy(InputStream in, OutputStream out, byte[] buffer)

拷贝流，拷贝后不关闭流

static long

copy(InputStream in, OutputStream out, int bufferSize)

拷贝流，拷贝后不关闭流

static void

copy(InputStream in, OutputStream out, int bufferSize, byte[] buffer)

拷贝流，拷贝后不关闭流

static void

copy(InputStream in, OutputStream out, int len, int swapBytes)

拷贝流，拷贝后不关闭流

static void

copy(InputStream in, OutputStream out, int bufferSize, int swapBytes, byte[] buffer)

拷贝流，拷贝后不关闭流

static long

copy(InputStream in, OutputStream out, int bufferSize, long count, StreamProgress streamProgress)

拷贝流，拷贝后不关闭流

static long

copy(InputStream in, OutputStream out, int bufferSize, StreamProgress streamProgress)

拷贝流，拷贝后不关闭流

static void

copy(InputStream in, OutputStream out, long bufferSize)

拷贝流，拷贝后不关闭流

static void

copy(InputStream in, OutputStream out, long bufferSize, byte[] buffer)

拷贝流，拷贝后不关闭流

static void

copy(InputStream in, OutputStream out, long len, int swapBytes)

拷贝流，拷贝后不关闭流

static void

copy(InputStream in, OutputStream out, long bufferSize, int swapBytes, byte[] buffer)

拷贝流，拷贝后不关闭流

static long

copy(Reader reader, Writer writer)

将Reader中的内容复制到Writer中使用默认缓存大小，拷贝后不关闭Reader

static long

copy(Reader reader, Writer writer, int bufferSize)

将Reader中的内容复制到Writer中，拷贝后不关闭Reader

static long

copy(Reader reader, Writer writer, int bufferSize, long count, StreamProgress streamProgress)

将Reader中的内容复制到Writer中，拷贝后不关闭Reader

static long

copy(Reader reader, Writer writer, int bufferSize, StreamProgress streamProgress)

将Reader中的内容复制到Writer中，拷贝后不关闭Reader

static long

copy(FileChannel in, FileChannel out)

拷贝文件Channel，使用NIO，拷贝后不会关闭channel

static long

copy(ReadableByteChannel in, WritableByteChannel out)

拷贝流，使用NIO，不会关闭channel

static long

copy(ReadableByteChannel in, WritableByteChannel out, int bufferSize)

拷贝流，使用NIO，不会关闭channel

static long

copy(ReadableByteChannel in, WritableByteChannel out, int bufferSize, long totalCount, StreamProgress streamProgress)

拷贝流，使用NIO，不会关闭channel

static long

copy(ReadableByteChannel in, WritableByteChannel out, int bufferSize, StreamProgress streamProgress)

拷贝流，使用NIO，不会关闭channel

static long

copyNio(InputStream in, OutputStream out, int bufferSize, long count, StreamProgress streamProgress)

拷贝流本方法不会关闭流

static long

copyNio(InputStream in, OutputStream out, int bufferSize, StreamProgress streamProgress)

拷贝流 thanks to: https://github.com/venusdrogon/feilong-io/blob/master/src/main/java/com/feilong/io/IOWriteUtil.java 本方法不会关闭流

static void

flush(Flushable flushable)

从缓存中刷出数据

static boolean

isAndroidGetsocknameError(AssertionError e)

Returns true if e is due to a firmware bug fixed after Android 4.2.2.

static LineIterator

lineIter(InputStream in, Charset charset)

返回行遍历器

static LineIterator

lineIter(Reader reader)

返回行遍历器

static void

nullSafeClose(Closeable closeable)

关闭关闭失败抛出IOException异常

static InputStream

openFileOrURL(String name)

static FastByteArrayOutputStream

read(InputStream in)

从流中读取内容，读到输出流中，读取完毕后关闭流

static FastByteArrayOutputStream

read(InputStream in, boolean isClose)

从流中读取内容，读到输出流中，读取完毕后可选是否关闭流

static String

read(InputStream in, Charset charset)

从流中读取内容，读取完毕后关闭流

static String

read(Reader reader)

从Reader中读取String，读取完毕后关闭Reader

static String

read(Reader reader, boolean isClose)

从Reader中读取String

static String

read(FileChannel fileChannel)

从FileChannel中读取UTF-8编码内容

static String

read(FileChannel fileChannel, Charset charset)

从FileChannel中读取内容

static FastByteArrayOutputStream

read(ReadableByteChannel channel)

从流中读取内容，读到输出流中

static String

read(ReadableByteChannel channel, Charset charset)

从流中读取内容，读取完毕后并不关闭流

static byte[]

readBytes(InputStream in)

从流中读取bytes，读取完毕后关闭流

static byte[]

readBytes(InputStream in, boolean isClose)

从流中读取bytes

static byte[]

readBytes(InputStream in, int length)

读取指定长度的byte数组，不关闭流

static String

readHex(InputStream in, int length, boolean toLowerCase)

读取16进制字符串

static void

readLines(InputStream in, Charset charset, ConsumerX<String> lineHandler)

按行读取数据，针对每行的数据做处理

static <T extends Collection<String>> T

readLines(InputStream in, Charset charset, T collection)

从流中读取内容

static void

readLines(InputStream in, ConsumerX<String> lineHandler)

按行读取UTF-8编码数据，针对每行的数据做处理

static <T extends Collection<String>> T

readLines(InputStream in, T collection)

从流中读取内容，使用UTF-8编码

static void

readLines(Reader reader, ConsumerX<String> lineHandler)

按行读取数据，针对每行的数据做处理 Reader自带编码定义，因此读取数据的编码跟随其编码。此方法不会关闭流，除非抛出异常

static <T extends Collection<String>> T

readLines(Reader reader, T collection)

从Reader中读取内容

static <T> T

readObject(InputStream in, Class<?>... acceptClasses)

从流中读取对象，即对象的反序列化，读取后不关闭流

static String

readUtf8(InputStream in)

从流中读取UTF8编码的内容

static int

reverseBytesInt(int i)

static long

reverseBytesLong(long v)

static short

reverseBytesShort(short s)

static Sink

sink(File file)

返回一个向file写入的接收器

static Sink

sink(OutputStream out)

返回一个向out写入的接收器

static Sink

sink(Socket socket)

返回一个向socket写入的接收器。优先选择这个方法，而不是sink(OutputStream)，因为这个方法支持超时当套接字写超时时，套接字将由任务线程异步关闭

static Sink

sink(Path path, OpenOption... options)

返回一个向path写入的接收器.

static void

sneakyRethrow(Throwable t)

即使被声明也不允许直接抛出这是一种很糟糕的做饭,很容易遭到攻击清理后捕获并重新抛出异常

static Source

source(File file)

返回从file读取的缓冲数据

static Source

source(InputStream in)

返回从in中读取的缓冲数据

static Source

source(Socket socket)

返回从socket读取的缓存信息。与source(InputStream)相比，更喜欢这个方法，因为这个方法支持超时。当套接字读取超时时，套接字将由任务线程异步关闭

static Source

source(Path path, OpenOption... options)

返回从path读取的缓冲数据

static InputStream

toAvailableStream(InputStream in)

将指定InputStream 转换为InputStream.available()方法可用的流。在Socket通信流中，服务端未返回数据情况下InputStream.available()方法始终为0 因此，在读取前需要调用InputStream.read()读取一个字节（未返回会阻塞），一旦读取到了，InputStream.available()方法就正常了。需要注意的是，在网络流中，是按照块来传输的，所以 InputStream.available() 读取到的并非最终长度，而是此次块的长度。此方法返回对象的规则为： FileInputStream 返回原对象，因为文件流的available方法本身可用其它InputStream 返回PushbackInputStream

static BomReader

toBomReader(InputStream in)

从InputStream中获取BomReader

static BufferedInputStream

toBuffered(InputStream in)

转换为BufferedInputStream

static BufferedInputStream

toBuffered(InputStream in, int bufferSize)

转换为BufferedInputStream

static BufferedOutputStream

toBuffered(OutputStream out)

转换为BufferedOutputStream

static BufferedOutputStream

toBuffered(OutputStream out, int bufferSize)

转换为BufferedOutputStream

static BufferedReader

toBuffered(Reader reader)

转换为BufferedReader

static BufferedReader

toBuffered(Reader reader, int bufferSize)

转换为BufferedReader

static BufferedWriter

toBuffered(Writer writer)

转换为BufferedWriter

static BufferedWriter

toBuffered(Writer writer, int bufferSize)

转换为BufferedWriter

static InputStream

toMarkSupport(InputStream in)

将InputStream转换为支持mark标记的流若原流支持mark标记，则返回原流，否则使用BufferedInputStream 包装之

static Reader

toMarkSupport(Reader reader)

将Reader转换为支持mark标记的Reader 若原Reader支持mark标记，则返回原Reader，否则使用BufferedReader 包装之

static PushbackReader

toPushBackReader(Reader reader, int pushBackSize)

获得PushbackReader 如果是PushbackReader强转返回，否则新建

static PushbackInputStream

toPushbackStream(InputStream in, int pushBackSize)

转换为PushbackInputStream 如果传入的输入流已经是PushbackInputStream，强转返回，否则新建一个

static BufferedReader

toReader(InputStream in, Charset charset)

获得一个Reader

static ByteArrayInputStream

toStream(byte[] content)

byte[] 转为ByteArrayInputStream

static ByteArrayInputStream

toStream(ByteArrayOutputStream out)

ByteArrayOutputStream转为ByteArrayInputStream

static InputStream

toStream(File file)

文件转为InputStream

static ByteArrayInputStream

toStream(String content)

String 转为UTF-8编码的字节流流

static ByteArrayInputStream

toStream(String content, Charset charset)

String 转为流

static InputStream

toStream(Path path)

文件转为InputStream

static ByteArrayInputStream

toStream(FastByteArrayOutputStream out)

FastByteArrayOutputStream转为ByteArrayInputStream

static String

toString(ByteArrayOutputStream out, Charset charset)

ByteArrayOutputStream 转换为String

static BufferedReader

toUtf8Reader(InputStream in)

获得一个文件读取器，默认使用 UTF-8 编码

static OutputStreamWriter

toUtf8Writer(OutputStream out)

获得一个Writer，默认编码UTF-8

static OutputStreamWriter

toWriter(OutputStream out, Charset charset)

获得一个Writer

static void

write(OutputStream out, boolean isCloseOut, byte[] content)

将byte[]写到流中

static void

write(OutputStream out, boolean isCloseOut, Object... contents)

将多部分内容写到流中，自动转换为UTF-8字符串

static void

write(OutputStream out, byte[] content)

将byte[]写到流中，并关闭目标流

static void

write(OutputStream out, Charset charset, boolean isCloseOut, Object... contents)

将多部分内容写到流中，自动转换为字符串

static void

writeObjects(OutputStream out, boolean isCloseOut, Object... contents)

将多部分内容写到流中

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

Constructor Details
- IoKit
  
  public IoKit()
Method Details
- copy
  
  public static long copy(Reader reader, Writer writer) throws InternalException
  
  将Reader中的内容复制到Writer中使用默认缓存大小，拷贝后不关闭Reader
  
  Parameters:
  
  reader - Reader
  
  writer - Writer
  
  Returns:
  
  拷贝的字节数
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static long copy(Reader reader, Writer writer, int bufferSize) throws InternalException
  
  将Reader中的内容复制到Writer中，拷贝后不关闭Reader
  
  Parameters:
  
  reader - Reader
  
  writer - Writer
  
  bufferSize - 缓存大小
  
  Returns:
  
  传输的byte数
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static long copy(Reader reader, Writer writer, int bufferSize, StreamProgress streamProgress) throws InternalException
  
  将Reader中的内容复制到Writer中，拷贝后不关闭Reader
  
  Parameters:
  
  reader - Reader
  
  writer - Writer
  
  bufferSize - 缓存大小
  
  streamProgress - 进度处理器
  
  Returns:
  
  传输的byte数
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static long copy(Reader reader, Writer writer, int bufferSize, long count, StreamProgress streamProgress) throws InternalException
  
  将Reader中的内容复制到Writer中，拷贝后不关闭Reader
  
  Parameters:
  
  reader - Reader，非空
  
  writer - Writer，非空
  
  bufferSize - 缓存大小，-1表示默认
  
  count - 最大长度，-1表示无限制
  
  streamProgress - 进度处理器，null表示无
  
  Returns:
  
  传输的byte数
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static long copy(InputStream in, OutputStream out) throws InternalException
  
  拷贝流，使用默认Buffer大小，拷贝后不关闭流
  
  Parameters:
  
  in - 输入流
  
  out - 输出流
  
  Returns:
  
  传输的byte数
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static long copy(InputStream in, OutputStream out, int bufferSize) throws InternalException
  
  拷贝流，拷贝后不关闭流
  
  Parameters:
  
  in - 输入流
  
  out - 输出流
  
  bufferSize - 缓存大小
  
  Returns:
  
  传输的byte数
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static long copy(InputStream in, OutputStream out, int bufferSize, StreamProgress streamProgress) throws InternalException
  
  拷贝流，拷贝后不关闭流
  
  Parameters:
  
  in - 输入流
  
  out - 输出流
  
  bufferSize - 缓存大小
  
  streamProgress - 进度条
  
  Returns:
  
  传输的byte数
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static long copy(InputStream in, OutputStream out, int bufferSize, long count, StreamProgress streamProgress) throws InternalException
  
  拷贝流，拷贝后不关闭流
  
  Parameters:
  
  in - 输入流
  
  out - 输出流
  
  bufferSize - 缓存大小
  
  count - 总拷贝长度，-1表示无限制
  
  streamProgress - 进度条
  
  Returns:
  
  传输的byte数
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static long copy(FileInputStream in, FileOutputStream out) throws InternalException
  
  拷贝文件流，使用NIO
  
  Parameters:
  
  in - 输入
  
  out - 输出
  
  Returns:
  
  拷贝的字节数
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static void copy(InputStream in, OutputStream out, byte[] buffer) throws IOException
  
  拷贝流，拷贝后不关闭流
  
  Parameters:
  
  in - 输入流
  
  out - 输出流
  
  buffer - 缓存
  
  Throws:
  
  IOException
- copy
  
  public static void copy(InputStream in, OutputStream out, int len, int swapBytes) throws InternalException
  
  拷贝流，拷贝后不关闭流
  
  Parameters:
  
  in - 输入流
  
  out - 输出流
  
  swapBytes - 交换字节
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static void copy(InputStream in, OutputStream out, long len, int swapBytes) throws InternalException
  
  拷贝流，拷贝后不关闭流
  
  Parameters:
  
  in - 输入流
  
  out - 输出流
  
  swapBytes - 交换字节
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static void copy(InputStream in, OutputStream out, long bufferSize) throws InternalException
  
  拷贝流，拷贝后不关闭流
  
  Parameters:
  
  in - 输入流
  
  out - 输出流
  
  bufferSize - 缓存大小
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static void copy(InputStream in, OutputStream out, int bufferSize, byte[] buffer) throws InternalException
  
  拷贝流，拷贝后不关闭流
  
  Parameters:
  
  in - 输入流
  
  out - 输出流
  
  bufferSize - 缓存大小
  
  buffer - 缓存
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static void copy(InputStream in, OutputStream out, long bufferSize, byte[] buffer) throws InternalException
  
  拷贝流，拷贝后不关闭流
  
  Parameters:
  
  in - 输入流
  
  out - 输出流
  
  bufferSize - 缓存大小
  
  buffer - 缓存
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static void copy(InputStream in, OutputStream out, int bufferSize, int swapBytes, byte[] buffer) throws InternalException
  
  拷贝流，拷贝后不关闭流
  
  Parameters:
  
  in - 输入流
  
  out - 输出流
  
  bufferSize - 缓存大小
  
  swapBytes - 交换字节
  
  buffer - 缓存
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static void copy(InputStream in, OutputStream out, long bufferSize, int swapBytes, byte[] buffer) throws InternalException
  
  拷贝流，拷贝后不关闭流
  
  Parameters:
  
  in - 输入流
  
  out - 输出流
  
  bufferSize - 缓存大小
  
  swapBytes - 交换字节
  
  buffer - 缓存
  
  Throws:
  
  InternalException - IO异常
- toUtf8Reader
  
  public static BufferedReader toUtf8Reader(InputStream in)
  
  获得一个文件读取器，默认使用 UTF-8 编码
  
  Parameters:
  
  in - 输入流
  
  Returns:
  
  BufferedReader对象
- toBomReader
  
  public static BomReader toBomReader(InputStream in)
  
  从InputStream中获取BomReader
  
  Parameters:
  
  in - InputStream
  
  Returns:
  
  BomReader
- toReader
  
  public static BufferedReader toReader(InputStream in, Charset charset)
  
  获得一个Reader
  
  Parameters:
  
  in - 输入流
  
  charset - 字符集
  
  Returns:
  
  BufferedReader对象
- toUtf8Writer
  
  public static OutputStreamWriter toUtf8Writer(OutputStream out)
  
  获得一个Writer，默认编码UTF-8
  
  Parameters:
  
  out - 输入流
  
  Returns:
  
  OutputStreamWriter对象
- toWriter
  
  public static OutputStreamWriter toWriter(OutputStream out, Charset charset)
  
  获得一个Writer
  
  Parameters:
  
  out - 输入流
  
  charset - 字符集
  
  Returns:
  
  OutputStreamWriter对象
- readUtf8
  
  public static String readUtf8(InputStream in) throws InternalException
  
  从流中读取UTF8编码的内容
  
  Parameters:
  
  in - 输入流
  
  Returns:
  
  内容
  
  Throws:
  
  InternalException - IO异常
- read
  
  public static String read(InputStream in, Charset charset) throws InternalException
  
  从流中读取内容，读取完毕后关闭流
  
  Parameters:
  
  in - 输入流，读取完毕后关闭流
  
  charset - 字符集
  
  Returns:
  
  内容
  
  Throws:
  
  InternalException - IO异常
- read
  
  public static FastByteArrayOutputStream read(InputStream in) throws InternalException
  
  从流中读取内容，读到输出流中，读取完毕后关闭流
  
  Parameters:
  
  in - 输入流
  
  Returns:
  
  输出流
  
  Throws:
  
  InternalException - IO异常
- read
  
  public static FastByteArrayOutputStream read(InputStream in, boolean isClose) throws InternalException
  
  从流中读取内容，读到输出流中，读取完毕后可选是否关闭流
  
  Parameters:
  
  in - 输入流
  
  isClose - 读取完毕后是否关闭流
  
  Returns:
  
  输出流
  
  Throws:
  
  InternalException - IO异常
- read
  
  public static String read(Reader reader) throws InternalException
  
  从Reader中读取String，读取完毕后关闭Reader
  
  Parameters:
  
  reader - Reader
  
  Returns:
  
  String
  
  Throws:
  
  InternalException - IO异常
- read
  
  public static String read(Reader reader, boolean isClose) throws InternalException
  
  从Reader中读取String
  
  Parameters:
  
  reader - Reader
  
  isClose - 是否关闭Reader
  
  Returns:
  
  String
  
  Throws:
  
  InternalException - IO异常
- readBytes
  
  public static byte[] readBytes(InputStream in) throws InternalException
  
  从流中读取bytes，读取完毕后关闭流
  
  Parameters:
  
  in - InputStream
  
  Returns:
  
  bytes
  
  Throws:
  
  InternalException - IO异常
- readBytes
  
  public static byte[] readBytes(InputStream in, boolean isClose) throws InternalException
  
  从流中读取bytes
  
  Parameters:
  
  in - InputStream
  
  isClose - 是否关闭输入流
  
  Returns:
  
  bytes
  
  Throws:
  
  InternalException - IO异常
- readBytes
  
  public static byte[] readBytes(InputStream in, int length) throws InternalException
  
  读取指定长度的byte数组，不关闭流
  
  Parameters:
  
  in - InputStream，为null返回null
  
  length - 长度，小于等于0返回空byte数组
  
  Returns:
  
  bytes
  
  Throws:
  
  InternalException - IO异常
- readHex
  
  public static String readHex(InputStream in, int length, boolean toLowerCase) throws InternalException
  
  读取16进制字符串
  
  Parameters:
  
  in - InputStream
  
  length - 长度
  
  toLowerCase - true 传换成小写格式， false 传换成大写格式
  
  Returns:
  
  16进制字符串
  
  Throws:
  
  InternalException - IO异常
- readObject
  
  public static <T> T readObject(InputStream in, Class<?>... acceptClasses) throws InternalException
  
  从流中读取对象，即对象的反序列化，读取后不关闭流
  注意！！！此方法不会检查反序列化安全，可能存在反序列化漏洞风险！！！
  
  Type Parameters:
  
  T - 读取对象的类型
  
  Parameters:
  
  in - 输入流
  
  acceptClasses - 读取对象类型
  
  Returns:
  
  输出流
  
  Throws:
  
  InternalException - IO异常
  
  InternalException - ClassNotFoundException包装
- readLines
  
  public static <T extends Collection<String>> T readLines(InputStream in, T collection) throws InternalException
  
  从流中读取内容，使用UTF-8编码
  
  Type Parameters:
  
  T - 集合类型
  
  Parameters:
  
  in - 输入流
  
  collection - 返回集合
  
  Returns:
  
  内容
  
  Throws:
  
  InternalException - IO异常
- readLines
  
  public static <T extends Collection<String>> T readLines(InputStream in, Charset charset, T collection) throws InternalException
  
  从流中读取内容
  
  Type Parameters:
  
  T - 集合类型
  
  Parameters:
  
  in - 输入流
  
  charset - 字符集
  
  collection - 返回集合
  
  Returns:
  
  内容
  
  Throws:
  
  InternalException - IO异常
- readLines
  
  public static <T extends Collection<String>> T readLines(Reader reader, T collection) throws InternalException
  
  从Reader中读取内容
  
  Type Parameters:
  
  T - 集合类型
  
  Parameters:
  
  reader - Reader
  
  collection - 返回集合
  
  Returns:
  
  内容
  
  Throws:
  
  InternalException - IO异常
- readLines
  
  public static void readLines(InputStream in, ConsumerX<String> lineHandler) throws InternalException
  
  按行读取UTF-8编码数据，针对每行的数据做处理
  
  Parameters:
  
  in - InputStream
  
  lineHandler - 行处理接口，实现handle方法用于编辑一行的数据后入到指定地方
  
  Throws:
  
  InternalException - IO异常
- readLines
  
  public static void readLines(InputStream in, Charset charset, ConsumerX<String> lineHandler) throws InternalException
  
  按行读取数据，针对每行的数据做处理
  
  Parameters:
  
  in - InputStream
  
  charset - Charset编码
  
  lineHandler - 行处理接口，实现handle方法用于编辑一行的数据后入到指定地方
  
  Throws:
  
  InternalException - IO异常
- readLines
  
  public static void readLines(Reader reader, ConsumerX<String> lineHandler) throws InternalException
  
  按行读取数据，针对每行的数据做处理 Reader自带编码定义，因此读取数据的编码跟随其编码。此方法不会关闭流，除非抛出异常
  
  Parameters:
  
  reader - Reader
  
  lineHandler - 行处理接口，实现handle方法用于编辑一行的数据后入到指定地方
  
  Throws:
  
  InternalException - IO异常
- toStream
  
  public static ByteArrayInputStream toStream(String content)
  
  String 转为UTF-8编码的字节流流
  
  Parameters:
  
  content - 内容
  
  Returns:
  
  字节流
- toStream
  
  public static ByteArrayInputStream toStream(String content, Charset charset)
  
  String 转为流
  
  Parameters:
  
  content - 内容
  
  charset - 编码
  
  Returns:
  
  字节流
- toStream
  
  public static InputStream toStream(File file)
  
  文件转为InputStream
  
  Parameters:
  
  file - 文件，非空
  
  Returns:
  
  InputStream
- toStream
  
  public static InputStream toStream(Path path)
  
  文件转为InputStream
  
  Parameters:
  
  path - Path，非空
  
  Returns:
  
  InputStream
- toStream
  
  public static ByteArrayInputStream toStream(byte[] content)
  
  byte[] 转为ByteArrayInputStream
  
  Parameters:
  
  content - 内容bytes
  
  Returns:
  
  字节流
- toStream
  
  public static ByteArrayInputStream toStream(ByteArrayOutputStream out)
  
  ByteArrayOutputStream转为ByteArrayInputStream
  
  Parameters:
  
  out - ByteArrayOutputStream
  
  Returns:
  
  字节流
- toStream
  
  public static ByteArrayInputStream toStream(FastByteArrayOutputStream out)
  
  FastByteArrayOutputStream转为ByteArrayInputStream
  
  Parameters:
  
  out - FastByteArrayOutputStream
  
  Returns:
  
  字节流
- toBuffered
  
  public static BufferedInputStream toBuffered(InputStream in)
  
  转换为BufferedInputStream
  
  Parameters:
  
  in - InputStream
  
  Returns:
  
  BufferedInputStream
- toBuffered
  
  public static BufferedInputStream toBuffered(InputStream in, int bufferSize)
  
  转换为BufferedInputStream
  
  Parameters:
  
  in - InputStream
  
  bufferSize - buffer size
  
  Returns:
  
  BufferedInputStream
- toBuffered
  
  public static BufferedOutputStream toBuffered(OutputStream out)
  
  转换为BufferedOutputStream
  
  Parameters:
  
  out - OutputStream
  
  Returns:
  
  BufferedOutputStream
- toBuffered
  
  public static BufferedOutputStream toBuffered(OutputStream out, int bufferSize)
  
  转换为BufferedOutputStream
  
  Parameters:
  
  out - OutputStream
  
  bufferSize - buffer size
  
  Returns:
  
  BufferedOutputStream
- toBuffered
  
  public static BufferedReader toBuffered(Reader reader)
  
  转换为BufferedReader
  
  Parameters:
  
  reader - Reader
  
  Returns:
  
  BufferedReader
- toBuffered
  
  public static BufferedReader toBuffered(Reader reader, int bufferSize)
  
  转换为BufferedReader
  
  Parameters:
  
  reader - Reader
  
  bufferSize - buffer size
  
  Returns:
  
  BufferedReader
- toBuffered
  
  public static BufferedWriter toBuffered(Writer writer)
  
  转换为BufferedWriter
  
  Parameters:
  
  writer - Writer
  
  Returns:
  
  BufferedWriter
- toBuffered
  
  public static BufferedWriter toBuffered(Writer writer, int bufferSize)
  
  转换为BufferedWriter
  
  Parameters:
  
  writer - Writer
  
  bufferSize - buffer size
  
  Returns:
  
  BufferedWriter
- toMarkSupport
  
  public static InputStream toMarkSupport(InputStream in)
  
  将InputStream转换为支持mark标记的流若原流支持mark标记，则返回原流，否则使用BufferedInputStream 包装之
  
  Parameters:
  
  in - 流
  
  Returns:
  
  InputStream
- toMarkSupport
  
  public static Reader toMarkSupport(Reader reader)
  
  将Reader转换为支持mark标记的Reader 若原Reader支持mark标记，则返回原Reader，否则使用BufferedReader 包装之
  
  Parameters:
  
  reader - Reader
  
  Returns:
  
  Reader
- toPushBackReader
  
  public static PushbackReader toPushBackReader(Reader reader, int pushBackSize)
  
  获得PushbackReader 如果是PushbackReader强转返回，否则新建
  
  Parameters:
  
  reader - 普通Reader
  
  pushBackSize - 推后的byte数
  
  Returns:
  
  PushbackReader
- toPushbackStream
  
  public static PushbackInputStream toPushbackStream(InputStream in, int pushBackSize)
  
  转换为PushbackInputStream 如果传入的输入流已经是PushbackInputStream，强转返回，否则新建一个
  
  Parameters:
  
  in - InputStream
  
  pushBackSize - 推后的byte数
  
  Returns:
  
  PushbackInputStream
- toAvailableStream
  
  public static InputStream toAvailableStream(InputStream in)
  将指定InputStream 转换为InputStream.available()方法可用的流。在Socket通信流中，服务端未返回数据情况下InputStream.available()方法始终为0 因此，在读取前需要调用InputStream.read()读取一个字节（未返回会阻塞），一旦读取到了，InputStream.available()方法就正常了。需要注意的是，在网络流中，是按照块来传输的，所以 InputStream.available() 读取到的并非最终长度，而是此次块的长度。此方法返回对象的规则为：
  
  FileInputStream 返回原对象，因为文件流的available方法本身可用
  
  其它InputStream 返回PushbackInputStream
  Parameters:
  
  in - 被转换的流
  
  Returns:
  
  转换后的流，可能为PushbackInputStream
- write
  
  public static void write(OutputStream out, byte[] content) throws InternalException
  
  将byte[]写到流中，并关闭目标流
  
  Parameters:
  
  out - 输出流
  
  content - 写入的内容
  
  Throws:
  
  InternalException - IO异常
- write
  
  public static void write(OutputStream out, boolean isCloseOut, byte[] content) throws InternalException
  
  将byte[]写到流中
  
  Parameters:
  
  out - 输出流
  
  isCloseOut - 写入完毕是否关闭输出流
  
  content - 写入的内容
  
  Throws:
  
  InternalException - IO异常
- write
  
  public static void write(OutputStream out, boolean isCloseOut, Object... contents) throws InternalException
  
  将多部分内容写到流中，自动转换为UTF-8字符串
  
  Parameters:
  
  out - 输出流
  
  isCloseOut - 写入完毕是否关闭输出流
  
  contents - 写入的内容，调用toString()方法，不包括不会自动换行
  
  Throws:
  
  InternalException - IO异常
- write
  
  public static void write(OutputStream out, Charset charset, boolean isCloseOut, Object... contents) throws InternalException
  
  将多部分内容写到流中，自动转换为字符串
  
  Parameters:
  
  out - 输出流
  
  charset - 写出的内容的字符集
  
  isCloseOut - 写入完毕是否关闭输出流
  
  contents - 写入的内容，调用toString()方法，不包括不会自动换行
  
  Throws:
  
  InternalException - IO异常
- writeObjects
  
  public static void writeObjects(OutputStream out, boolean isCloseOut, Object... contents) throws InternalException
  
  将多部分内容写到流中
  
  Parameters:
  
  out - 输出流
  
  isCloseOut - 写入完毕是否关闭输出流
  
  contents - 写入的内容
  
  Throws:
  
  InternalException - IO异常
- read
  
  public static String read(FileChannel fileChannel) throws InternalException
  
  从FileChannel中读取UTF-8编码内容
  
  Parameters:
  
  fileChannel - 文件管道
  
  Returns:
  
  内容
  
  Throws:
  
  InternalException - IO异常
- read
  
  public static String read(FileChannel fileChannel, Charset charset) throws InternalException
  
  从FileChannel中读取内容
  
  Parameters:
  
  fileChannel - 文件管道
  
  charset - 字符集
  
  Returns:
  
  内容
  
  Throws:
  
  InternalException - IO异常
- read
  
  public static FastByteArrayOutputStream read(ReadableByteChannel channel) throws InternalException
  
  从流中读取内容，读到输出流中
  
  Parameters:
  
  channel - 可读通道，读取完毕后并不关闭通道
  
  Returns:
  
  输出流
  
  Throws:
  
  InternalException - IO异常
- read
  
  public static String read(ReadableByteChannel channel, Charset charset) throws InternalException
  
  从流中读取内容，读取完毕后并不关闭流
  
  Parameters:
  
  channel - 可读通道，读取完毕后并不关闭通道
  
  charset - 字符集
  
  Returns:
  
  内容
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static long copy(FileChannel in, FileChannel out) throws InternalException
  
  拷贝文件Channel，使用NIO，拷贝后不会关闭channel
  
  Parameters:
  
  in - FileChannel，非空
  
  out - FileChannel，非空
  
  Returns:
  
  拷贝的字节数
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static long copy(ReadableByteChannel in, WritableByteChannel out) throws InternalException
  
  拷贝流，使用NIO，不会关闭channel
  
  Parameters:
  
  in - ReadableByteChannel
  
  out - WritableByteChannel
  
  Returns:
  
  拷贝的字节数
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static long copy(ReadableByteChannel in, WritableByteChannel out, int bufferSize) throws InternalException
  
  拷贝流，使用NIO，不会关闭channel
  
  Parameters:
  
  in - ReadableByteChannel
  
  out - WritableByteChannel
  
  bufferSize - 缓冲大小，如果小于等于0，使用默认
  
  Returns:
  
  拷贝的字节数
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static long copy(ReadableByteChannel in, WritableByteChannel out, int bufferSize, StreamProgress streamProgress) throws InternalException
  
  拷贝流，使用NIO，不会关闭channel
  
  Parameters:
  
  in - ReadableByteChannel
  
  out - WritableByteChannel
  
  bufferSize - 缓冲大小，如果小于等于0，使用默认
  
  streamProgress - StreamProgress进度处理器
  
  Returns:
  
  拷贝的字节数
  
  Throws:
  
  InternalException - IO异常
- copy
  
  public static long copy(ReadableByteChannel in, WritableByteChannel out, int bufferSize, long totalCount, StreamProgress streamProgress)
  
  拷贝流，使用NIO，不会关闭channel
  
  Parameters:
  
  in - ReadableByteChannel
  
  out - WritableByteChannel
  
  bufferSize - 缓冲大小，如果小于等于0，使用默认
  
  totalCount - 读取总长度
  
  streamProgress - StreamProgress进度处理器
  
  Returns:
  
  拷贝的字节数
- copyNio
  
  public static long copyNio(InputStream in, OutputStream out, int bufferSize, StreamProgress streamProgress) throws InternalException
  
  拷贝流 thanks to: https://github.com/venusdrogon/feilong-io/blob/master/src/main/java/com/feilong/io/IOWriteUtil.java 本方法不会关闭流
  
  Parameters:
  
  in - 输入流
  
  out - 输出流
  
  bufferSize - 缓存大小
  
  streamProgress - 进度条
  
  Returns:
  
  传输的byte数
  
  Throws:
  
  InternalException - IO异常
- copyNio
  
  public static long copyNio(InputStream in, OutputStream out, int bufferSize, long count, StreamProgress streamProgress) throws InternalException
  
  拷贝流本方法不会关闭流
  
  Parameters:
  
  in - 输入流，非空
  
  out - 输出流，非空
  
  bufferSize - 缓存大小，-1表示默认
  
  count - 最大长度，-1表示无限制
  
  streamProgress - 进度条，null表示无进度条
  
  Returns:
  
  传输的byte数
  
  Throws:
  
  InternalException - IO异常
- flush
  
  public static void flush(Flushable flushable)
  
  从缓存中刷出数据
  
  Parameters:
  
  flushable - Flushable
- close
  
  public static void close(Object obj)
  
  尝试关闭指定对象判断对象如果实现了AutoCloseable，则调用之
  
  Parameters:
  
  obj - 可关闭对象
- close
  
  public static void close(Closeable closeable)
  
  关闭关闭失败不会抛出异常
  
  Parameters:
  
  closeable - 被关闭的对象
- close
  
  public static void close(AutoCloseable autoCloseable)
  
  关闭关闭失败不会抛出异常
  
  Parameters:
  
  autoCloseable - 被关闭的对象
- close
  
  public static void close(Socket socket)
  
  关闭关闭失败不会抛出异常
  
  Parameters:
  
  socket - 被关闭的对象
- close
  
  public static void close(ServerSocket serverSocket)
  
  Parameters:
  
  serverSocket - 被关闭的对象关闭serverSocket，忽略任何已检查的异常。如果serverSocket为空，则不执行任何操作
- close
  
  public static void close(AsynchronousSocketChannel channel)
  
  Parameters:
  
  channel - 需要被关闭的通道
- closeQuietly
  
  public static void closeQuietly(AutoCloseable... closeables)
  
  按照给定顺序连续关闭一系列对象这些对象必须按照顺序关闭，否则会出错。
  
  Parameters:
  
  closeables - 需要关闭的对象
- isAndroidGetsocknameError
  
  public static boolean isAndroidGetsocknameError(AssertionError e)
  
  Returns true if e is due to a firmware bug fixed after Android 4.2.2. https://code.google.com/p/android/issues/detail?id=54072
- nullSafeClose
  
  public static void nullSafeClose(Closeable closeable) throws IOException
  
  关闭关闭失败抛出IOException异常
  
  Parameters:
  
  closeable - 被关闭的对象
  
  Throws:
  
  IOException - IO异常
- sink
  
  public static Sink sink(OutputStream out)
  
  返回一个向out写入的接收器
  
  Parameters:
  
  out - 输出流
  
  Returns:
  
  接收缓冲区
- sink
  
  public static Sink sink(Socket socket) throws IOException
  
  返回一个向socket写入的接收器。优先选择这个方法，而不是sink(OutputStream)，因为这个方法支持超时当套接字写超时时，套接字将由任务线程异步关闭
  
  Parameters:
  
  socket - 套接字
  
  Returns:
  
  接收器
  
  Throws:
  
  IOException - IO异常
- source
  
  public static Source source(InputStream in)
  
  返回从in中读取的缓冲数据
  
  Parameters:
  
  in - 数据输入流
  
  Returns:
  
  缓冲数据
- source
  
  public static Source source(File file) throws FileNotFoundException
  
  返回从file读取的缓冲数据
  
  Parameters:
  
  file - 文件
  
  Returns:
  
  缓冲数据
  
  Throws:
  
  FileNotFoundException - 文件未找到
- source
  
  public static Source source(Path path, OpenOption... options) throws IOException
  
  返回从path读取的缓冲数据
  
  Parameters:
  
  path - 路径
  
  options - 选项
  
  Returns:
  
  缓冲数据
  
  Throws:
  
  IOException - IO异常
- sink
  
  public static Sink sink(File file) throws FileNotFoundException
  
  返回一个向file写入的接收器
  
  Parameters:
  
  file - 文件
  
  Returns:
  
  接收器
  
  Throws:
  
  FileNotFoundException - 文件未找到
- appendingSink
  
  public static Sink appendingSink(File file) throws FileNotFoundException
  
  返回一个附加到file的接收器
  
  Parameters:
  
  file - 文件
  
  Returns:
  
  接收器
  
  Throws:
  
  FileNotFoundException - 文件未找到
- sink
  
  public static Sink sink(Path path, OpenOption... options) throws IOException
  
  返回一个向path写入的接收器.
  
  Parameters:
  
  path - 路径
  
  options - 属性
  
  Returns:
  
  写入的数据的接收器
  
  Throws:
  
  IOException - IO异常
- blackhole
  
  public static Sink blackhole()
  
  返回一个都不写的接收器
  
  Returns:
  
  接收器
- source
  
  public static Source source(Socket socket) throws IOException
  
  返回从socket读取的缓存信息。与source(InputStream)相比，更喜欢这个方法，因为这个方法支持超时。当套接字读取超时时，套接字将由任务线程异步关闭
  
  Parameters:
  
  socket - 套接字
  
  Returns:
  
  取的缓存信息
  
  Throws:
  
  IOException - IO异常
- contentEquals
  
  public static boolean contentEquals(InputStream input1, InputStream input2) throws InternalException
  
  对比两个流内容是否相同内部会转换流为 BufferedInputStream
  
  Parameters:
  
  input1 - 第一个流
  
  input2 - 第二个流
  
  Returns:
  
  两个流的内容一致返回true，否则false
  
  Throws:
  
  InternalException - IO异常
- contentEquals
  
  public static boolean contentEquals(Reader input1, Reader input2) throws InternalException
  
  对比两个Reader的内容是否一致内部会转换流为 BufferedInputStream
  
  Parameters:
  
  input1 - 第一个reader
  
  input2 - 第二个reader
  
  Returns:
  
  两个流的内容一致返回true，否则false
  
  Throws:
  
  InternalException - IO异常
- contentEqualsIgnoreEOL
  
  public static boolean contentEqualsIgnoreEOL(Reader input1, Reader input2) throws InternalException
  
  对比两个流内容是否相同，忽略EOL字符内部会转换流为 BufferedInputStream
  
  Parameters:
  
  input1 - 第一个流
  
  input2 - 第二个流
  
  Returns:
  
  两个流的内容一致返回true，否则false
  
  Throws:
  
  InternalException - IO异常
- lineIter
  
  public static LineIterator lineIter(Reader reader)
  返回行遍历器
  LineIterator it = null; try { it = IoKit.lineIter(reader); while (it.hasNext()) { String line = it.nextLine(); // do something with line } } finally { it.close(); }
  Parameters:
  
  reader - Reader
  
  Returns:
  
  LineIterator
- lineIter
  
  public static LineIterator lineIter(InputStream in, Charset charset)
  返回行遍历器
  LineIterator it = null; try { it = IoKit.lineIter(in, Charset.CHARSET_UTF_8); while (it.hasNext()) { String line = it.nextLine(); // do something with line } } finally { it.close(); }
  Parameters:
  
  in - InputStream
  
  charset - 编码
  
  Returns:
  
  LineIterator
- toString
  
  public static String toString(ByteArrayOutputStream out, Charset charset)
  
  ByteArrayOutputStream 转换为String
  
  Parameters:
  
  out - ByteArrayOutputStream
  
  charset - 编码
  
  Returns:
  
  字符串
- checkOffsetAndCount
  
  public static void checkOffsetAndCount(long size, long offset, long byteCount)
- sneakyRethrow
  
  public static void sneakyRethrow(Throwable t)
  
  即使被声明也不允许直接抛出这是一种很糟糕的做饭,很容易遭到攻击清理后捕获并重新抛出异常
  
  Parameters:
  
  t - 异常
- arrayRangeEquals
  
  public static boolean arrayRangeEquals(byte[] a, int aOffset, byte[] b, int bOffset, int byteCount)
- buffer
  
  public static BufferSource buffer(Source source)
  
  返回缓冲区从source读取的字节流返回的源将对其内存缓冲区执行批量读取
  
  Parameters:
  
  source - 字节流
  
  Returns:
  
  返回缓冲区
- buffer
  
  public static BufferSink buffer(Sink sink)
  
  返回一个新接收器，该接收器缓冲写sink 返回的接收器将批量写入sink
  
  Parameters:
  
  sink - 接收一个字节流
  
  Returns:
  
  接收缓冲区
- reverseBytesShort
  
  public static short reverseBytesShort(short s)
- reverseBytesInt
  
  public static int reverseBytesInt(int i)
- reverseBytesLong
  
  public static long reverseBytesLong(long v)
- openFileOrURL
  
  public static InputStream openFileOrURL(String name) throws IOException
  
  Throws:
  
  IOException

Class IoKit

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

IoKit

Method Details

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

toUtf8Reader

toBomReader

toReader

toUtf8Writer

toWriter

readUtf8

read

read

read

read

read

readBytes

readBytes

readBytes

readHex

readObject

readLines

readLines

readLines

readLines

readLines

readLines

toStream

toStream

toStream

toStream

toStream

toStream

toStream

toBuffered

toBuffered

toBuffered

toBuffered

toBuffered

toBuffered

toBuffered

toBuffered

toMarkSupport

toMarkSupport

toPushBackReader

toPushbackStream

toAvailableStream

write

write

write

write

writeObjects

read

read

read

read

copy

copy

copy

copy

copy