FaceUtilits (common-java-码云(gitee.com))

java.lang.Object
- net.gdface.utils.FaceUtilits

public class FaceUtilits
extends java.lang.Object

Author:: guyadong

Constructor Summary

Constructors
Constructor and Description

FaceUtilits()

Constructors
Constructor and Description
`FaceUtilits()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.net.URI`	`createURI(java.lang.String urlStr)` 将`URL`字符串转换为`URI`对象在转换过程中会将自动对不符合URI规范的字符进行编码, 在转换过程中先从字符串生成`URL`对象,如果`String`不能转换成URL对象，则抛出异常
`static <K,V> boolean`	`equals(java.util.Map<K,V> m1, java.util.Map<K,V> m2)` 比较两个Map是否相等
`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 java.lang.Throwable`	`getCause(java.lang.Throwable e)`
`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.lang.Class<?>[]`	`getParameterizedType(java.lang.Class<?> clazz)` 返回`clazz`泛型超类的参数对象如果超类不是泛型对象，则抛出`IllegalArgumentException`
`static java.lang.Class<?>[]`	`getParameterizedTypeNoThrow(java.lang.Class<?> clazz)` 如果无法获取泛型参数对象，返回null
`static java.nio.ByteBuffer`	`hex2ByteBuffer(java.lang.String src)`
`static byte[]`	`hex2Bytes(java.lang.String src)`
`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.io.File`	`saveImage(java.io.InputStream img, java.io.File folder)`
`static java.io.File`	`saveImageAutoName(byte[] img, java.io.File folder)` 将图片数据保存在folder指定的文件夹下,文件名用图片的md5校验码命名,自动判断文件后缀
`static void`	`storeSortedMap(java.util.Map<java.lang.String,java.lang.String> map, java.io.Writer writer, java.lang.String lineSeparator)` 对`Map`中元素以key排序后，每行以{key}={value}形式输出到`Writer` map为空或null时则不向writer写入任何内容
`static void`	`storeSortedSet(java.util.Collection<java.lang.String> collection, java.io.Writer writer, java.lang.String lineSeparator)` 对 `Collection`中元素排序后(去除重复)，元素分行输出到`Writer` collection为空或null时则不向writer写入任何内容
`static java.lang.Throwable`	`stripThrowableShell(java.lang.Throwable e, java.lang.Class<? extends java.lang.Throwable> shellClass)` 以递归方式返回被`shellClass`多层封装的异常
`static java.lang.String`	`toHex(byte[] buffer)` 将16位byte[] 转换为32位的HEX格式的字符串String
`static java.lang.String`	`toHex(java.nio.ByteBuffer buffer)`
`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
  - FaceUtilits
```
public FaceUtilits()
```
- Method Detail
  - getMD5
```
public static byte[] getMD5(byte[] source)
```
    生成MD5校验码
    
    Parameters:
    
    source -
    
    Returns:
  - getBytesInBuffer
```
public static final byte[] getBytesInBuffer(java.nio.ByteBuffer buffer)
```
    返回buffer中所有字节(position~limit),不改变buffer状态
    
    Parameters:
    
    buffer -
    
    Returns:
    
    buffer 为 null 时返回 null
  - getMD5
```
public static java.nio.ByteBuffer getMD5(java.nio.ByteBuffer source)
```
    生成MD5校验码
    
    Parameters:
    
    source -
    
    Returns:
    
    See Also:
    
    getMD5(byte[])
  - toHex
```
public static java.lang.String toHex(byte[] buffer)
```
    将16位byte[] 转换为32位的HEX格式的字符串String
    
    Parameters:
    
    buffer -
    
    Returns:
  - toHex
```
public static java.lang.String toHex(java.nio.ByteBuffer buffer)
```
    See Also:
    
    toHex(byte[])
  - validHEX
```
public boolean validHEX(java.lang.String input)
```
    字符串验证器,根据正则表达式判断字符串是否为十六进制(HEX)字符串输入为null或空或正则表达式不匹配则返回false
  - hex2Bytes
```
public static byte[] hex2Bytes(java.lang.String src)
```
  - hex2ByteBuffer
```
public static java.nio.ByteBuffer hex2ByteBuffer(java.lang.String src)
```
  - getMD5String
```
public static java.lang.String getMD5String(byte[] source)
```
    生成MD5校验码字符串
    
    Parameters:
    
    source -
    
    Returns:
    
    See Also:
    
    getMD5(byte[]), toHex(byte[])
  - getMD5String
```
public static java.lang.String getMD5String(java.nio.ByteBuffer source)
```
    生成MD5校验码字符串
    
    Parameters:
    
    source -
    
    Returns:
    
    See Also:
    
    getMD5(byte[]), toHex(byte[])
  - validMd5
```
public static final boolean validMd5(java.lang.String md5)
```
    判断是否为有效的MD5字符串
    
    Returns:
  - readBytes
```
public static byte[] readBytes(java.io.InputStream in)
                        throws java.io.IOException,
                               java.lang.IllegalArgumentException
```
    从InputStream读取字节数组
    当in为FileInputStream时，调用readBytes(FileInputStream)(NIO方式)读取
    结束时会关闭InputStream
    
    Parameters:
    
    in -
    
    Returns:
    
    Throws:
    
    java.io.IOException
    
    java.lang.IllegalArgumentException - in为null
  - readBytes
```
public static 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 <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或类型不对则抛出异常
    
    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,
                                                java.lang.IllegalArgumentException
```
    调用 getBytes(Object)返回非空字节数组
    如果返回null或空字节数组，则抛出IOException
    
    Parameters:
    
    src -
    
    Returns:
    
    Throws:
    
    java.io.IOException
    
    java.lang.IllegalArgumentException
    
    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 -
    
    Returns:
    
    Throws:
    
    java.io.IOException
    
    java.lang.IllegalArgumentException
    
    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
  - saveImageAutoName
```
public static java.io.File saveImageAutoName(byte[] img,
                                             java.io.File folder)
                                      throws java.io.IOException,
                                             java.lang.IllegalArgumentException
```
    将图片数据保存在folder指定的文件夹下,文件名用图片的md5校验码命名,自动判断文件后缀
    
    Parameters:
    
    img - 图像数据
    
    folder - 文件保存的位置
    
    Returns:
    
    返回保存的文件名,如果img中无法获取格式名，则视为无效数据，不保存，返回null;
    
    Throws:
    
    java.io.IOException - 调用FaceUtilitsX.getFormatName(byte[])获取图像格式名称出错或其他IO异常
    
    java.lang.IllegalArgumentException - data为null或空时
    
    See Also:
    
    saveBytes(byte[], File, boolean)
  - saveImage
```
public static java.io.File saveImage(java.io.InputStream img,
                                     java.io.File folder)
                              throws java.io.IOException,
                                     java.lang.IllegalArgumentException
```
    Parameters:
    
    img -
    
    folder - 文件保存位置
    
    Returns:
    
    返回保存的文件,如果从img中读取的数据为空返回null
    
    Throws:
    
    java.io.IOException - 数据非可识别的图像格式或其他IO异常
    
    java.lang.IllegalArgumentException - img为null
    
    See Also:
    
    saveImageAutoName(byte[], File)
  - createURI
```
public static java.net.URI createURI(java.lang.String urlStr)
                              throws java.net.MalformedURLException
```
    将URL字符串转换为URI对象
    在转换过程中会将自动对不符合URI规范的字符进行编码,
    在转换过程中先从字符串生成URL对象,如果String不能转换成URL对象，则抛出异常
    
    Parameters:
    
    urlStr -
    
    Returns:
    
    Throws:
    
    java.net.MalformedURLException
  - saveBytes
```
public static 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时
  - getParameterizedTypeNoThrow
```
public static java.lang.Class<?>[] getParameterizedTypeNoThrow(java.lang.Class<?> clazz)
```
    如果无法获取泛型参数对象，返回null
    
    Parameters:
    
    clazz -
    
    Returns:
    
    See Also:
    
    getParameterizedType(Class)
  - getParameterizedType
```
public static java.lang.Class<?>[] getParameterizedType(java.lang.Class<?> clazz)
                                                 throws java.lang.reflect.MalformedParameterizedTypeException,
                                                        java.lang.IllegalArgumentException
```
    返回clazz泛型超类的参数对象
    如果超类不是泛型对象，则抛出IllegalArgumentException
    
    Parameters:
    
    clazz -
    
    Returns:
    
    Throws:
    
    java.lang.reflect.MalformedParameterizedTypeException - 超类不是泛型类
    
    java.lang.IllegalArgumentException - 无法获取实际泛型参数对象类型
  - getCause
```
public static final java.lang.Throwable getCause(java.lang.Throwable e)
```
  - stripThrowableShell
```
public static final java.lang.Throwable stripThrowableShell(java.lang.Throwable e,
                                                            java.lang.Class<? extends java.lang.Throwable> shellClass)
```
    以递归方式返回被shellClass多层封装的异常
    
    Parameters:
    
    e -
    
    shellClass - 封装异常的类
    
    Returns:
  - storeSortedMap
```
public static void storeSortedMap(java.util.Map<java.lang.String,java.lang.String> map,
                                  java.io.Writer writer,
                                  java.lang.String lineSeparator)
                           throws java.io.IOException
```
    对Map中元素以key排序后，每行以{key}={value}形式输出到Writer
    map为空或null时则不向writer写入任何内容
    
    Parameters:
    
    map -
    
    writer - 为null抛出IllegalArgumentException
    
    lineSeparator - 换行符,为null则使用系统默认的换行符(windows \n linux \r\n)
    
    Throws:
    
    java.io.IOException
  - storeSortedSet
```
public static void storeSortedSet(java.util.Collection<java.lang.String> collection,
                                  java.io.Writer writer,
                                  java.lang.String lineSeparator)
                           throws java.io.IOException
```
    对 Collection中元素排序后(去除重复)，元素分行输出到Writer
    collection为空或null时则不向writer写入任何内容
    
    Parameters:
    
    collection -
    
    writer - 为null抛出IllegalArgumentException
    
    lineSeparator - 换行符,为null则使用系统默认的换行符(windows \n linux \r\n)
    
    Throws:
    
    java.io.IOException
  - equals
```
public static <K,V> boolean equals(java.util.Map<K,V> m1,
                                   java.util.Map<K,V> m2)
```
    比较两个Map是否相等
    
    Parameters:
    
    m1 -
    
    m2 -
    
    Returns:

Class FaceUtilits

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FaceUtilits

Method Detail

getMD5

getBytesInBuffer

getMD5

toHex

toHex

validHEX

hex2Bytes

hex2ByteBuffer

getMD5String

getMD5String

validMd5

readBytes

readBytes

getInputStream

getBytes

getBytesNotEmpty

getByteBuffer

getByteBufferNotEmpty

saveImageAutoName

saveImage

createURI

saveBytes

getParameterizedTypeNoThrow

getParameterizedType

getCause

stripThrowableShell

storeSortedMap

storeSortedSet

equals