BinaryUtils (sql2java-stor 3.0.0 API)

java.lang.Object
- gu.sql2java.store.BinaryUtils

```
public class BinaryUtils
extends java.lang.Object
```
二进制数据(byte[],ByteBuffer)工具类

Author:

guyadong

Constructor Summary

Constructors
Constructor and Description

BinaryUtils()

Constructors
Constructor and Description
`BinaryUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> java.nio.ByteBuffer`	`getByteBuffer(T src)` 将数据对象src转换为`ByteBuffer`
`static <T> java.nio.ByteBuffer`	`getByteBufferNotEmpty(T src)` 调用 `getByteBuffer(Object)`返回非空`ByteBuffer` 如果返回`null`或空，则抛出`IOException`
`static <T> byte[]`	`getBytes(T src)` 将数据对象`src`转换为字节数组(byte[]) `src`的数据类型可以是byte[],`InputStream`,`ByteBuffer`,`String`(base64编码),`File`,`URL`,`URI` 否则抛出`IllegalArgumentException` 对象转换为InputStream或byte[]时,可能会抛出`IOException` 当`src`为`File`或`FileInputStream`时，使用NIO方式(`readBytes(FileInputStream)`)读取
`static byte[]`	`getBytesInBuffer(java.nio.ByteBuffer buffer)` 返回buffer中所有字节(position~limit),不改变buffer状态
`static <T> byte[]`	`getBytesNotEmpty(T src)` 调用 `getBytes(Object)`返回非空字节数组如果返回`null`或空字节数组，则抛出`IOException`
`static <T> java.io.InputStream`	`getInputStream(T src)` 将对象转换为InputStream 类型可以是byte[],`ByteBuffer`,`InputStream`,`String`(base64编码),`File`,`URL`,`URI`,否则抛出RuntimeException
`static byte[]`	`getMD5(byte[] source)` 生成MD5校验码
`static java.nio.ByteBuffer`	`getMD5(java.nio.ByteBuffer source)` 生成MD5校验码
`static java.lang.String`	`getMD5String(byte[] source)` 生成MD5校验码字符串
`static java.lang.String`	`getMD5String(java.nio.ByteBuffer source)` 生成MD5校验码字符串
`static java.nio.ByteBuffer`	`hex2ByteBuffer(java.lang.String src)` convert HEX string to ByteBuffer
`static byte[]`	`hex2Bytes(java.lang.String src)` convert HEX string to byte array
`static byte[]`	`readBytes(java.io.FileInputStream fin)` NIO方式从`FileInputStream`读取字节数组结束时会关闭`InputStream`
`static byte[]`	`readBytes(java.io.InputStream in)` 从`InputStream`读取字节数组当`in`为`FileInputStream`时，调用`readBytes(FileInputStream)`(NIO方式)读取结束时会关闭`InputStream`
`static java.io.File`	`saveBytes(byte[] data, java.io.File file, boolean overwrite)` NIO方式将`data`数据保存在`file`指定的文件中如果`file`所在文件夹不存在，则会自动创建所有的文件夹
`static java.lang.String`	`toHex(byte[] buffer)` 将16位byte[] 转换为32位的HEX格式的字符串String
`static java.lang.String`	`toHex(java.nio.ByteBuffer buffer)`
`static boolean`	`validHEX(java.lang.String input)` 字符串验证器,根据正则表达式判断字符串是否为十六进制(HEX)字符串输入为null或空或正则表达式不匹配则返回false
`static boolean`	`validMd5(java.lang.String md5)` 判断是否为有效的MD5字符串

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

- Constructor Detail
  - BinaryUtils
```
public BinaryUtils()
```
- Method Detail
  - getMD5
```
public static final byte[] getMD5(byte[] source)
```
    生成MD5校验码
    
    Parameters:
    
    source -
  - getBytesInBuffer
```
public static final byte[] getBytesInBuffer(java.nio.ByteBuffer buffer)
```
    返回buffer中所有字节(position~limit),不改变buffer状态
    
    Parameters:
    
    buffer -
    
    Returns:
    
    buffer 为 null 时返回 null
  - getMD5
```
public static final java.nio.ByteBuffer getMD5(java.nio.ByteBuffer source)
```
    生成MD5校验码
    
    Parameters:
    
    source -
    
    See Also:
    
    getMD5(byte[])
  - toHex
```
public static final java.lang.String toHex(byte[] buffer)
```
    将16位byte[] 转换为32位的HEX格式的字符串String
    
    Parameters:
    
    buffer -
  - toHex
```
public static final java.lang.String toHex(java.nio.ByteBuffer buffer)
```
    See Also:
    
    toHex(byte[])
  - validHEX
```
public static final boolean validHEX(java.lang.String input)
```
    字符串验证器,根据正则表达式判断字符串是否为十六进制(HEX)字符串输入为null或空或正则表达式不匹配则返回false
  - hex2Bytes
```
public static final byte[] hex2Bytes(java.lang.String src)
```
    convert HEX string to byte array
    
    Parameters:
    
    src -
    
    Returns:
    
    byte array or null if src is null
  - hex2ByteBuffer
```
public static final java.nio.ByteBuffer hex2ByteBuffer(java.lang.String src)
```
    convert HEX string to ByteBuffer
    
    Parameters:
    
    src -
    
    Returns:
    
    byte array or null if src is null
  - getMD5String
```
public static final java.lang.String getMD5String(byte[] source)
```
    生成MD5校验码字符串
    
    Parameters:
    
    source -
    
    See Also:
    
    getMD5(byte[]), toHex(byte[])
  - getMD5String
```
public static final java.lang.String getMD5String(java.nio.ByteBuffer source)
```
    生成MD5校验码字符串
    
    Parameters:
    
    source -
    
    See Also:
    
    getMD5(byte[]), toHex(byte[])
  - validMd5
```
public static final boolean validMd5(java.lang.String md5)
```
    判断是否为有效的MD5字符串
  - readBytes
```
public static final byte[] readBytes(java.io.InputStream in)
                              throws java.io.IOException,
                                     java.lang.IllegalArgumentException
```
    从InputStream读取字节数组
    当in为FileInputStream时，调用readBytes(FileInputStream)(NIO方式)读取
    结束时会关闭InputStream
    
    Parameters:
    
    in - 为null返回null
    
    Returns:
    
    字节数组，如果输入为null返回null
    
    Throws:
    
    java.io.IOException
    
    java.lang.IllegalArgumentException - in为null
  - readBytes
```
public static final byte[] readBytes(java.io.FileInputStream fin)
                              throws java.io.IOException
```
    NIO方式从FileInputStream读取字节数组
    结束时会关闭InputStream
    
    Parameters:
    
    fin - FileInputStream
    
    Returns:
    
    返回读取的字节数当fin为null时返回null;
    
    Throws:
    
    java.io.IOException
  - getInputStream
```
public static final <T> java.io.InputStream getInputStream(T src)
                                                    throws java.io.IOException,
                                                           java.lang.IllegalArgumentException
```
    将对象转换为InputStream
    类型可以是byte[],ByteBuffer,InputStream,String(base64编码),File,URL,URI,否则抛出RuntimeException
    
    Parameters:
    
    src - 获取InputStream的源对象
    
    Returns:
    
    返回获取的InputStream对象,src为null返回null,类型错误抛出异常
    
    Throws:
    
    java.io.IOException
    
    java.lang.IllegalArgumentException - 无法从src获取InputStream
  - getBytes
```
public static final <T> byte[] getBytes(T src)
                                 throws java.io.IOException,
                                        java.lang.IllegalArgumentException
```
    将数据对象src转换为字节数组(byte[])
    src的数据类型可以是byte[],InputStream,ByteBuffer,String(base64编码),File,URL,URI 否则抛出IllegalArgumentException
    对象转换为InputStream或byte[]时,可能会抛出IOException 当src为File或FileInputStream时，使用NIO方式(readBytes(FileInputStream))读取
    
    Parameters:
    
    src - 获取byte[]的源对象
    
    Returns:
    
    返回字节数组,参数为null返回null,类型不对则抛出异常
    
    Throws:
    
    java.io.IOException
    
    java.lang.IllegalArgumentException - src为null或无法从src获取InputStream
    
    See Also:
    
    readBytes(InputStream), readBytes(FileInputStream), getInputStream(Object), Base64Utils.decode(String)
  - getBytesNotEmpty
```
public static final <T> byte[] getBytesNotEmpty(T src)
                                         throws java.io.IOException
```
    调用 getBytes(Object)返回非空字节数组
    如果返回null或空字节数组，则抛出IOException
    
    Parameters:
    
    src - 获取byte[]的源对象
    
    Returns:
    
    返回非空字节数组
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    getBytes(Object)
  - getByteBuffer
```
public static final <T> java.nio.ByteBuffer getByteBuffer(T src)
                                                   throws java.io.IOException,
                                                          java.lang.IllegalArgumentException
```
    将数据对象src转换为ByteBuffer
    
    Parameters:
    
    src - 获取byte[]的源对象
    
    Returns:
    
    返回字节数组,参数为null返回null,类型不对则抛出异常
    
    Throws:
    
    java.io.IOException
    
    java.lang.IllegalArgumentException - 无法从src获取InputStream
    
    See Also:
    
    getBytes(Object)
  - getByteBufferNotEmpty
```
public static final <T> java.nio.ByteBuffer getByteBufferNotEmpty(T src)
                                                           throws java.io.IOException,
                                                                  java.lang.IllegalArgumentException
```
    调用 getByteBuffer(Object)返回非空ByteBuffer
    如果返回null或空，则抛出IOException
    
    Parameters:
    
    src -
    
    Returns:
    
    返回非空字节数组
    
    Throws:
    
    java.io.IOException
    
    java.lang.IllegalArgumentException
  - saveBytes
```
public static final java.io.File saveBytes(byte[] data,
                                           java.io.File file,
                                           boolean overwrite)
                                    throws java.io.IOException,
                                           java.lang.IllegalArgumentException
```
    NIO方式将data数据保存在file指定的文件中
    如果file所在文件夹不存在，则会自动创建所有的文件夹
    
    Parameters:
    
    data -
    
    file - 文件保存的位置
    
    overwrite - 同名文件存在时是否覆盖
    
    Returns:
    
    返回保存的文件名
    
    Throws:
    
    java.io.IOException - file存在但不是文件或其他IO异常
    
    java.lang.IllegalArgumentException - data为null时

Class BinaryUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BinaryUtils

Method Detail

getMD5

getBytesInBuffer

getMD5

toHex

toHex

validHEX

hex2Bytes

hex2ByteBuffer

getMD5String

getMD5String

validMd5

readBytes

readBytes

getInputStream

getBytes

getBytesNotEmpty

getByteBuffer

getByteBufferNotEmpty

saveBytes