$ (bus-all 5.5.3 API)

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

```
public class $
extends Object
```
工具包集合,工具类快捷方式

Since:

JDK 1.8+

Version:

5.5.3

Author:

Kimi Liu

Constructor Summary

Constructors
Constructor and Description

$()

Constructors
Constructor and Description
`$()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`cleanIdentifier(String param)` 获取标识符,用于参数清理
`static String`	`cleanText(String txt)` 清理字符串,清理出某些不可见字符和一些sql特殊字符
`static String[]`	`concat(String[] one, String[] other)` Concatenates 2 arrays
`static <T> T[]`	`concat(T[] one, T[] other, Class<T> clazz)` Concatenates 2 arrays
`static boolean`	`contains(Enumeration<?> enumeration, Object element)` 判断枚举是否包含该元素
`static boolean`	`contains(Iterator<?> iterator, Object element)` 判断迭代器中是否包含元素
`static <T> boolean`	`contains(T[] array, T element)` 判断数组中是否包含元素
`static Object`	`defaultIfNull(Object object, Object defaultValue)` 如果对象为null,返回默认值
`static boolean`	`equals(Object o1, Object o2)` 对象 eq
`static boolean`	`equalsSafe(Object o1, Object o2)` 安全的 equals
`static String`	`firstCharToLower(String str)` 首字母变小写
`static String`	`firstCharToUpper(String str)` 首字母变大写
`static String`	`format(String message, Map<String,Object> params)` 将字符串中特定模式的字符转换成map中对应的值
`static String`	`format(String message, Object... arguments)` 同 log 格式的 format 规则
`static int`	`hashCode(Object obj)` 返回对象的 hashCode
`static boolean`	`isAnyBlank(CharSequence... css)` 判断是否有任意一个空字符串
`static boolean`	`isArray(Object obj)` 判断对象是数组
`static boolean`	`isBlank(CharSequence cs)` 判断是否为空字符串 $.isBlank(null) = true $.isBlank("") = true $.isBlank(" ") = true $.isBlank("12345") = false $.isBlank(" 12345 ") = false
`static boolean`	`isEmpty(Object obj)` 判断空对象 object、map、list、set、字符串、数组
`static boolean`	`isEmpty(Object[] array)` 判断数组为空
`static boolean`	`isFalse(Boolean object)` 判断对象为false
`static boolean`	`isNotBlank(CharSequence cs)` 判断不为空字符串
`static boolean`	`isNotEmpty(Object obj)` 对象不为空 object、map、list、set、字符串、数组
`static boolean`	`isNotEmpty(Object[] array)` 判断数组不为空
`static boolean`	`isNotEqual(Object o1, Object o2)` 比较两个对象是否不相等
`static boolean`	`isNotNull(Object obj)` 判断对象是否 not null
`static boolean`	`isNull(Object obj)` 判断对象是否为null
`static boolean`	`isTrue(Boolean object)` 判断对象为true
`static <E> List<E>`	`ofImmutableList(E... es)` 不可变 List
`static <E> Set<E>`	`ofImmutableSet(E... es)` 不可变 Set
`static <T> T`	`requireNotNull(T obj)` 断言,必须不能为 null
`static <T> T`	`requireNotNull(T obj, String message)` 断言,必须不能为 null
`static <T> T`	`requireNotNull(T obj, Supplier<String> messageSupplier)` 断言,必须不能为 null

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

- Constructor Detail
  - $
```
public $()
```
- Method Detail
  - requireNotNull
```
public static <T> T requireNotNull(T obj)
```
    断言,必须不能为 null
    
    Type Parameters:
    
    T - the type of the reference
    
    Parameters:
    
    obj - the object reference to check for nullity
    
    Returns:
    
    obj if not null
    
    Throws:
    
    NullPointerException - if obj is null
  - requireNotNull
```
public static <T> T requireNotNull(T obj,
                                   String message)
```
    断言,必须不能为 null
    
    Type Parameters:
    
    T - the type of the reference
    
    Parameters:
    
    obj - the object reference to check for nullity
    
    message - detail message to be used in the event that a NullPointerException is thrown
    
    Returns:
    
    obj if not null
    
    Throws:
    
    NullPointerException - if obj is null
  - requireNotNull
```
public static <T> T requireNotNull(T obj,
                                   Supplier<String> messageSupplier)
```
    断言,必须不能为 null
    
    Type Parameters:
    
    T - the type of the reference
    
    Parameters:
    
    obj - the object reference to check for nullity
    
    messageSupplier - supplier of the detail message to be used in the event that a NullPointerException is thrown
    
    Returns:
    
    obj if not null
    
    Throws:
    
    NullPointerException - if obj is null
  - isTrue
```
public static boolean isTrue(Boolean object)
```
    判断对象为true
    
    Parameters:
    
    object - 对象
    
    Returns:
    
    对象是否为true
  - isFalse
```
public static boolean isFalse(Boolean object)
```
    判断对象为false
    
    Parameters:
    
    object - 对象
    
    Returns:
    
    对象是否为false
  - isNull
```
public static boolean isNull(Object obj)
```
    判断对象是否为null
    This method exists to be used as a Predicate, context($::isNull)
    
    Parameters:
    
    obj - a reference to be checked against null
    
    Returns:
    
    true if the provided reference is null otherwise false
    
    See Also:
    
    Predicate
  - isNotNull
```
public static boolean isNotNull(Object obj)
```
    判断对象是否 not null
    This method exists to be used as a Predicate, context($::notNull)
    
    Parameters:
    
    obj - a reference to be checked against null
    
    Returns:
    
    true if the provided reference is non-null otherwise false
    
    See Also:
    
    Predicate
  - firstCharToLower
```
public static String firstCharToLower(String str)
```
    首字母变小写
    
    Parameters:
    
    str - 字符串
    
    Returns:
    
    {String}
  - firstCharToUpper
```
public static String firstCharToUpper(String str)
```
    首字母变大写
    
    Parameters:
    
    str - 字符串
    
    Returns:
    
    {String}
  - isBlank
```
public static boolean isBlank(CharSequence cs)
```
    判断是否为空字符串
```
 $.isBlank(null)                = true
 $.isBlank("")          = true
 $.isBlank(" ")         = true
 $.isBlank("12345")     = false
 $.isBlank(" 12345 ")   = false
 
```
    Parameters:
    
    cs - the CharSequence to check (may be null)
    
    Returns:
    
    true if the CharSequence is not null, its length is greater than 0, and it does not contain whitespace only
    
    See Also:
    
    Character.isWhitespace(char)
  - isNotBlank
```
public static boolean isNotBlank(CharSequence cs)
```
    判断不为空字符串
```
 $.isNotBlank(null)     = false
 $.isNotBlank("")               = false
 $.isNotBlank(" ")      = false
 $.isNotBlank("bob")    = true
 $.isNotBlank("  bob  ") = true
 
```
    Parameters:
    
    cs - the CharSequence to check, may be null
    
    Returns:
    
    true if the CharSequence is not empty and not null and not whitespace
    
    See Also:
    
    Character.isWhitespace(char)
  - isAnyBlank
```
public static boolean isAnyBlank(CharSequence... css)
```
    判断是否有任意一个空字符串
    
    Parameters:
    
    css - CharSequence
    
    Returns:
    
    boolean
  - isArray
```
public static boolean isArray(Object obj)
```
    判断对象是数组
    
    Parameters:
    
    obj - the object to check
    
    Returns:
    
    是否数组
  - isEmpty
```
public static boolean isEmpty(Object obj)
```
    判断空对象 object、map、list、set、字符串、数组
    
    Parameters:
    
    obj - the object to check
    
    Returns:
    
    数组是否为空
  - isNotEmpty
```
public static boolean isNotEmpty(Object obj)
```
    对象不为空 object、map、list、set、字符串、数组
    
    Parameters:
    
    obj - the object to check
    
    Returns:
    
    是否不为空
  - isEmpty
```
public static boolean isEmpty(Object[] array)
```
    判断数组为空
    
    Parameters:
    
    array - the array to check
    
    Returns:
    
    数组是否为空
  - isNotEmpty
```
public static boolean isNotEmpty(Object[] array)
```
    判断数组不为空
    
    Parameters:
    
    array - 数组
    
    Returns:
    
    数组是否不为空
  - format
```
public static String format(String message,
                            Map<String,Object> params)
```
    将字符串中特定模式的字符转换成map中对应的值
    use: format("my name is ${name}, and i like ${like}!", {"name":"L.cm", "like": "Java"})
    
    Parameters:
    
    message - 需要转换的字符串
    
    params - 转换所需的键值对集合
    
    Returns:
    
    转换后的字符串
  - format
```
public static String format(String message,
                            Object... arguments)
```
    同 log 格式的 format 规则
    use: format("my name is {}, and i like {}!", "L.cm", "Java")
    
    Parameters:
    
    message - 需要转换的字符串
    
    arguments - 需要替换的变量
    
    Returns:
    
    转换后的字符串
  - cleanText
```
public static String cleanText(String txt)
```
    清理字符串,清理出某些不可见字符和一些sql特殊字符
    
    Parameters:
    
    txt - 文本
    
    Returns:
    
    {String}
  - cleanIdentifier
```
public static String cleanIdentifier(String param)
```
    获取标识符,用于参数清理
    
    Parameters:
    
    param - 参数
    
    Returns:
    
    清理后的标识符
  - equalsSafe
```
public static boolean equalsSafe(Object o1,
                                 Object o2)
```
    安全的 equals
    
    Parameters:
    
    o1 - first Object to compare
    
    o2 - second Object to compare
    
    Returns:
    
    whether the given objects are equal
    
    See Also:
    
    Object.equals(Object), Arrays.equals(long[], long[])
  - equals
```
public static boolean equals(Object o1,
                             Object o2)
```
    对象 eq
    
    Parameters:
    
    o1 - Object
    
    o2 - Object
    
    Returns:
    
    是否eq
  - isNotEqual
```
public static boolean isNotEqual(Object o1,
                                 Object o2)
```
    比较两个对象是否不相等
    
    Parameters:
    
    o1 - 对象1
    
    o2 - 对象2
    
    Returns:
    
    是否不eq
  - hashCode
```
public static int hashCode(Object obj)
```
    返回对象的 hashCode
    
    Parameters:
    
    obj - Object
    
    Returns:
    
    hashCode
  - defaultIfNull
```
public static Object defaultIfNull(Object object,
                                   Object defaultValue)
```
    如果对象为null,返回默认值
    
    Parameters:
    
    object - Object
    
    defaultValue - 默认值
    
    Returns:
    
    Object
  - contains
```
public static <T> boolean contains(T[] array,
                                   T element)
```
    判断数组中是否包含元素
    
    Type Parameters:
    
    T - The generic tag
    
    Parameters:
    
    array - the Array to check
    
    element - the element to look for
    
    Returns:
    
    true if found, false else
  - contains
```
public static boolean contains(Iterator<?> iterator,
                               Object element)
```
    判断迭代器中是否包含元素
    
    Parameters:
    
    iterator - the Iterator to check
    
    element - the element to look for
    
    Returns:
    
    true if found, false otherwise
  - contains
```
public static boolean contains(Enumeration<?> enumeration,
                               Object element)
```
    判断枚举是否包含该元素
    
    Parameters:
    
    enumeration - the Enumeration to check
    
    element - the element to look for
    
    Returns:
    
    true if found, false otherwise
  - concat
```
public static String[] concat(String[] one,
                              String[] other)
```
    Concatenates 2 arrays
    
    Parameters:
    
    one - 数组1
    
    other - 数组2
    
    Returns:
    
    新数组
  - concat
```
public static <T> T[] concat(T[] one,
                             T[] other,
                             Class<T> clazz)
```
    Concatenates 2 arrays
    
    Type Parameters:
    
    T - 对象
    
    Parameters:
    
    one - 数组1
    
    other - 数组2
    
    clazz - 数组类
    
    Returns:
    
    新数组
  - ofImmutableSet
```
public static <E> Set<E> ofImmutableSet(E... es)
```
    不可变 Set
    
    Type Parameters:
    
    E - 泛型
    
    Parameters:
    
    es - 对象
    
    Returns:
    
    集合
  - ofImmutableList
```
public static <E> List<E> ofImmutableList(E... es)
```
    不可变 List
    
    Type Parameters:
    
    E - 泛型
    
    Parameters:
    
    es - 对象
    
    Returns:
    
    集合

Class $

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

$

Method Detail

requireNotNull

requireNotNull

requireNotNull

isTrue

isFalse

isNull

isNotNull

firstCharToLower

firstCharToUpper

isBlank

isNotBlank

isAnyBlank

isArray

isEmpty

isNotEmpty

isEmpty

isNotEmpty

format

format

cleanText

cleanIdentifier

equalsSafe

equals

isNotEqual

hashCode

defaultIfNull

contains

contains

contains

concat

concat

ofImmutableSet

ofImmutableList