package com.dahuatech.hutool.core.util;
import com.dahuatech.hutool.core.convert.Convert;
/**
* Boolean类型相关工具类
*
* @author looly
* @since 4.1.16
*/
public class BooleanUtil {
/** 表示为真的字符串 */
private static final String[] TRUE_ARRAY = {
"true", "yes", "y", "t", "ok", "1", "on", "是", "对", "真",
};
/**
* 取相反值
*
* @param bool Boolean值
* @return 相反的Boolean值
*/
public static Boolean negate(Boolean bool) {
if (bool == null) {
return null;
}
return bool.booleanValue() ? Boolean.FALSE : Boolean.TRUE;
}
/**
* 检查 {@code Boolean} 值是否为 {@code true}
*
*
* BooleanUtil.isTrue(Boolean.TRUE) = true
* BooleanUtil.isTrue(Boolean.FALSE) = false
* BooleanUtil.isTrue(null) = false
*
*
* @param bool 被检查的Boolean值
* @return 当值为true且非null时返回{@code true}
*/
public static boolean isTrue(Boolean bool) {
return Boolean.TRUE.equals(bool);
}
/**
* 检查 {@code Boolean} 值是否为 {@code false}
*
*
* BooleanUtil.isFalse(Boolean.TRUE) = false
* BooleanUtil.isFalse(Boolean.FALSE) = true
* BooleanUtil.isFalse(null) = false
*
*
* @param bool 被检查的Boolean值
* @return 当值为false且非null时返回{@code true}
*/
public static boolean isFalse(Boolean bool) {
return Boolean.FALSE.equals(bool);
}
/**
* 取相反值
*
* @param bool Boolean值
* @return 相反的Boolean值
*/
public static boolean negate(boolean bool) {
return bool ? false : true;
}
/**
* 转换字符串为boolean值
*
* @param valueStr 字符串
* @return boolean值
*/
public static boolean toBoolean(String valueStr) {
if (StrUtil.isNotBlank(valueStr)) {
valueStr = valueStr.trim().toLowerCase();
return ArrayUtil.contains(TRUE_ARRAY, valueStr);
}
return false;
}
/**
* boolean值转为int
*
* @param value Boolean值
* @return int值
*/
public static int toInt(boolean value) {
return value ? 1 : 0;
}
/**
* boolean值转为Integer
*
* @param value Boolean值
* @return Integer值
*/
public static Integer toInteger(boolean value) {
return Integer.valueOf(toInt(value));
}
/**
* boolean值转为char
*
* @param value Boolean值
* @return char值
*/
public static char toChar(boolean value) {
return (char) toInt(value);
}
/**
* boolean值转为Character
*
* @param value Boolean值
* @return Character值
*/
public static Character toCharacter(boolean value) {
return Character.valueOf(toChar(value));
}
/**
* boolean值转为byte
*
* @param value Boolean值
* @return byte值
*/
public static byte toByte(boolean value) {
return (byte) toInt(value);
}
/**
* boolean值转为Byte
*
* @param value Boolean值
* @return Byte值
*/
public static Byte toByteObj(boolean value) {
return Byte.valueOf(toByte(value));
}
/**
* boolean值转为long
*
* @param value Boolean值
* @return long值
*/
public static long toLong(boolean value) {
return (long) toInt(value);
}
/**
* boolean值转为Long
*
* @param value Boolean值
* @return Long值
*/
public static Long toLongObj(boolean value) {
return Long.valueOf(toLong(value));
}
/**
* boolean值转为short
*
* @param value Boolean值
* @return short值
*/
public static short toShort(boolean value) {
return (short) toInt(value);
}
/**
* boolean值转为Short
*
* @param value Boolean值
* @return Short值
*/
public static Short toShortObj(boolean value) {
return Short.valueOf(toShort(value));
}
/**
* boolean值转为float
*
* @param value Boolean值
* @return float值
*/
public static float toFloat(boolean value) {
return (float) toInt(value);
}
/**
* boolean值转为Float
*
* @param value Boolean值
* @return float值
*/
public static Float toFloatObj(boolean value) {
return Float.valueOf(toFloat(value));
}
/**
* boolean值转为double
*
* @param value Boolean值
* @return double值
*/
public static double toDouble(boolean value) {
return (double) toInt(value);
}
/**
* boolean值转为double
*
* @param value Boolean值
* @return double值
*/
public static Double toDoubleObj(boolean value) {
return Double.valueOf(toDouble(value));
}
/**
* 将boolean转换为字符串 {@code 'true'} 或者 {@code 'false'}.
*
*
* BooleanUtil.toStringTrueFalse(true) = "true"
* BooleanUtil.toStringTrueFalse(false) = "false"
*
*
* @param bool Boolean值
* @return {@code 'true'}, {@code 'false'}
*/
public static String toStringTrueFalse(boolean bool) {
return toString(bool, "true", "false");
}
/**
* 将boolean转换为字符串 {@code 'on'} 或者 {@code 'off'}.
*
*
* BooleanUtil.toStringOnOff(true) = "on"
* BooleanUtil.toStringOnOff(false) = "off"
*
*
* @param bool Boolean值
* @return {@code 'on'}, {@code 'off'}
*/
public static String toStringOnOff(boolean bool) {
return toString(bool, "on", "off");
}
/**
* 将boolean转换为字符串 {@code 'yes'} 或者 {@code 'no'}.
*
*
* BooleanUtil.toStringYesNo(true) = "yes"
* BooleanUtil.toStringYesNo(false) = "no"
*
*
* @param bool Boolean值
* @return {@code 'yes'}, {@code 'no'}
*/
public static String toStringYesNo(boolean bool) {
return toString(bool, "yes", "no");
}
/**
* 将boolean转换为字符串
*
*
* BooleanUtil.toString(true, "true", "false") = "true"
* BooleanUtil.toString(false, "true", "false") = "false"
*
*
* @param bool Boolean值
* @param trueString 当值为 {@code true}时返回此字符串, 可能为 {@code null}
* @param falseString 当值为 {@code false}时返回此字符串, 可能为 {@code null}
* @return 结果值
*/
public static String toString(boolean bool, String trueString, String falseString) {
return bool ? trueString : falseString;
}
/**
* 对Boolean数组取与
*
*
* BooleanUtil.and(true, true) = true
* BooleanUtil.and(false, false) = false
* BooleanUtil.and(true, false) = false
* BooleanUtil.and(true, true, false) = false
* BooleanUtil.and(true, true, true) = true
*
*
* @param array {@code Boolean}数组
* @return 取与为真返回{@code true}
*/
public static boolean and(boolean... array) {
if (ArrayUtil.isEmpty(array)) {
throw new IllegalArgumentException("The Array must not be empty !");
}
for (final boolean element : array) {
if (false == element) {
return false;
}
}
return true;
}
/**
* 对Boolean数组取与
*
*
* BooleanUtil.and(Boolean.TRUE, Boolean.TRUE) = Boolean.TRUE
* BooleanUtil.and(Boolean.FALSE, Boolean.FALSE) = Boolean.FALSE
* BooleanUtil.and(Boolean.TRUE, Boolean.FALSE) = Boolean.FALSE
* BooleanUtil.and(Boolean.TRUE, Boolean.TRUE, Boolean.TRUE) = Boolean.TRUE
* BooleanUtil.and(Boolean.FALSE, Boolean.FALSE, Boolean.TRUE) = Boolean.FALSE
* BooleanUtil.and(Boolean.TRUE, Boolean.FALSE, Boolean.TRUE) = Boolean.FALSE
*
*
* @param array {@code Boolean}数组
* @return 取与为真返回{@code true}
*/
public static Boolean and(final Boolean... array) {
if (ArrayUtil.isEmpty(array)) {
throw new IllegalArgumentException("The Array must not be empty !");
}
final boolean[] primitive = Convert.convert(boolean[].class, array);
return Boolean.valueOf(and(primitive));
}
/**
* 对Boolean数组取或
*
*
* BooleanUtil.or(true, true) = true
* BooleanUtil.or(false, false) = false
* BooleanUtil.or(true, false) = true
* BooleanUtil.or(true, true, false) = true
* BooleanUtil.or(true, true, true) = true
* BooleanUtil.or(false, false, false) = false
*
*
* @param array {@code Boolean}数组
* @return 取或为真返回{@code true}
*/
public static boolean or(boolean... array) {
if (ArrayUtil.isEmpty(array)) {
throw new IllegalArgumentException("The Array must not be empty !");
}
for (final boolean element : array) {
if (element) {
return true;
}
}
return false;
}
/**
* 对Boolean数组取或
*
*
* BooleanUtil.or(Boolean.TRUE, Boolean.TRUE) = Boolean.TRUE
* BooleanUtil.or(Boolean.FALSE, Boolean.FALSE) = Boolean.FALSE
* BooleanUtil.or(Boolean.TRUE, Boolean.FALSE) = Boolean.TRUE
* BooleanUtil.or(Boolean.TRUE, Boolean.TRUE, Boolean.TRUE) = Boolean.TRUE
* BooleanUtil.or(Boolean.FALSE, Boolean.FALSE, Boolean.TRUE) = Boolean.TRUE
* BooleanUtil.or(Boolean.TRUE, Boolean.FALSE, Boolean.TRUE) = Boolean.TRUE
* BooleanUtil.or(Boolean.FALSE, Boolean.FALSE, Boolean.FALSE) = Boolean.FALSE
*
*
* @param array {@code Boolean}数组
* @return 取或为真返回{@code true}
*/
public static Boolean or(Boolean... array) {
if (ArrayUtil.isEmpty(array)) {
throw new IllegalArgumentException("The Array must not be empty !");
}
final boolean[] primitive = Convert.convert(boolean[].class, array);
return Boolean.valueOf(or(primitive));
}
/**
* 对Boolean数组取异或
*
*
* BooleanUtil.xor(true, true) = false
* BooleanUtil.xor(false, false) = false
* BooleanUtil.xor(true, false) = true
* BooleanUtil.xor(true, true) = false
* BooleanUtil.xor(false, false) = false
* BooleanUtil.xor(true, false) = true
*
*
* @param array {@code boolean}数组
* @return 如果异或计算为true返回 {@code true}
*/
public static boolean xor(boolean... array) {
if (ArrayUtil.isEmpty(array)) {
throw new IllegalArgumentException("The Array must not be empty");
}
boolean result = false;
for (final boolean element : array) {
result ^= element;
}
return result;
}
/**
* 对Boolean数组取异或
*
*
* BooleanUtil.xor(new Boolean[] { Boolean.TRUE, Boolean.TRUE }) = Boolean.FALSE
* BooleanUtil.xor(new Boolean[] { Boolean.FALSE, Boolean.FALSE }) = Boolean.FALSE
* BooleanUtil.xor(new Boolean[] { Boolean.TRUE, Boolean.FALSE }) = Boolean.TRUE
*
*
* @param array {@code Boolean} 数组
* @return 异或为真取{@code true}
*/
public static Boolean xor(Boolean... array) {
if (ArrayUtil.isEmpty(array)) {
throw new IllegalArgumentException("The Array must not be empty !");
}
final boolean[] primitive = Convert.convert(boolean[].class, array);
return Boolean.valueOf(xor(primitive));
}
/**
* 给定类是否为Boolean或者boolean
*
* @param clazz 类
* @return 是否为Boolean或者boolean
* @since 4.5.2
*/
public static boolean isBoolean(Class clazz) {
return (clazz == Boolean.class || clazz == boolean.class);
}
}
