You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2016/01/16 23:37:40 UTC
[1/3] [commons-lang] Git Push Summary
Repository: commons-lang
Updated Branches:
refs/heads/master 18f5f54ca -> 69d4bf883
[2/3] [lang] Revert "Simplify, less clutter."
Posted by gg...@apache.org.
Revert "Simplify, less clutter."
This reverts commit 18f5f54ca0e78df12586e0750e257058746a5a39.
Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/bb76a684
Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/bb76a684
Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/bb76a684
Branch: refs/heads/master
Commit: bb76a6848b37cc3f418a370c56f597486618197b
Parents: 18f5f54
Author: ggregory <gg...@apache.org>
Authored: Sat Jan 16 14:36:50 2016 -0800
Committer: ggregory <gg...@apache.org>
Committed: Sat Jan 16 14:36:50 2016 -0800
----------------------------------------------------------------------
.../org/apache/commons/lang3/BooleanUtils.java | 2212 +++++++++---------
1 file changed, 1108 insertions(+), 1104 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/bb76a684/src/main/java/org/apache/commons/lang3/BooleanUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/lang3/BooleanUtils.java b/src/main/java/org/apache/commons/lang3/BooleanUtils.java
index 5d49c2c..ba5dea0 100644
--- a/src/main/java/org/apache/commons/lang3/BooleanUtils.java
+++ b/src/main/java/org/apache/commons/lang3/BooleanUtils.java
@@ -1,1104 +1,1108 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.apache.commons.lang3;
-
-import org.apache.commons.lang3.math.NumberUtils;
-
-/**
- * <p>Operations on boolean primitives and Boolean objects.</p>
- *
- * <p>This class tries to handle {@code null} input gracefully.
- * An exception will not be thrown for a {@code null} input.
- * Each method documents its behaviour in more detail.</p>
- *
- * <p>#ThreadSafe#</p>
- * @since 2.0
- */
-public class BooleanUtils {
-
- /**
- * <p>{@code BooleanUtils} instances should NOT be constructed in standard programming.
- * Instead, the class should be used as {@code BooleanUtils.negate(true);}.</p>
- *
- * <p>This constructor is public to permit tools that require a JavaBean instance
- * to operate.</p>
- */
- public BooleanUtils() {
- super();
- }
-
- // Boolean utilities
- //--------------------------------------------------------------------------
- /**
- * <p>Negates the specified boolean.</p>
- *
- * <p>If {@code null} is passed in, {@code null} will be returned.</p>
- *
- * <p>NOTE: This returns null and will throw a NullPointerException if autoboxed to a boolean. </p>
- *
- * <pre>
- * BooleanUtils.negate(Boolean.TRUE) = Boolean.FALSE;
- * BooleanUtils.negate(Boolean.FALSE) = Boolean.TRUE;
- * BooleanUtils.negate(null) = null;
- * </pre>
- *
- * @param bool the Boolean to negate, may be null
- * @return the negated Boolean, or {@code null} if {@code null} input
- */
- public static Boolean negate(final Boolean bool) {
- if (bool == null) {
- return null;
- }
- return bool.booleanValue() ? Boolean.FALSE : Boolean.TRUE;
- }
-
- // boolean Boolean methods
- //-----------------------------------------------------------------------
- /**
- * <p>Checks if a {@code Boolean} value is {@code true},
- * handling {@code null} by returning {@code false}.</p>
- *
- * <pre>
- * BooleanUtils.isTrue(Boolean.TRUE) = true
- * BooleanUtils.isTrue(Boolean.FALSE) = false
- * BooleanUtils.isTrue(null) = false
- * </pre>
- *
- * @param bool the boolean to check, null returns {@code false}
- * @return {@code true} only if the input is non-null and true
- * @since 2.1
- */
- public static boolean isTrue(final Boolean bool) {
- return Boolean.TRUE.equals(bool);
- }
-
- /**
- * <p>Checks if a {@code Boolean} value is <i>not</i> {@code true},
- * handling {@code null} by returning {@code true}.</p>
- *
- * <pre>
- * BooleanUtils.isNotTrue(Boolean.TRUE) = false
- * BooleanUtils.isNotTrue(Boolean.FALSE) = true
- * BooleanUtils.isNotTrue(null) = true
- * </pre>
- *
- * @param bool the boolean to check, null returns {@code true}
- * @return {@code true} if the input is null or false
- * @since 2.3
- */
- public static boolean isNotTrue(final Boolean bool) {
- return !isTrue(bool);
- }
-
- /**
- * <p>Checks if a {@code Boolean} value is {@code false},
- * handling {@code null} by returning {@code false}.</p>
- *
- * <pre>
- * BooleanUtils.isFalse(Boolean.TRUE) = false
- * BooleanUtils.isFalse(Boolean.FALSE) = true
- * BooleanUtils.isFalse(null) = false
- * </pre>
- *
- * @param bool the boolean to check, null returns {@code false}
- * @return {@code true} only if the input is non-null and false
- * @since 2.1
- */
- public static boolean isFalse(final Boolean bool) {
- return Boolean.FALSE.equals(bool);
- }
-
- /**
- * <p>Checks if a {@code Boolean} value is <i>not</i> {@code false},
- * handling {@code null} by returning {@code true}.</p>
- *
- * <pre>
- * BooleanUtils.isNotFalse(Boolean.TRUE) = true
- * BooleanUtils.isNotFalse(Boolean.FALSE) = false
- * BooleanUtils.isNotFalse(null) = true
- * </pre>
- *
- * @param bool the boolean to check, null returns {@code true}
- * @return {@code true} if the input is null or true
- * @since 2.3
- */
- public static boolean isNotFalse(final Boolean bool) {
- return !isFalse(bool);
- }
-
- //-----------------------------------------------------------------------
- /**
- * <p>Converts a Boolean to a boolean handling {@code null}
- * by returning {@code false}.</p>
- *
- * <pre>
- * BooleanUtils.toBoolean(Boolean.TRUE) = true
- * BooleanUtils.toBoolean(Boolean.FALSE) = false
- * BooleanUtils.toBoolean(null) = false
- * </pre>
- *
- * @param bool the boolean to convert
- * @return {@code true} or {@code false}, {@code null} returns {@code false}
- */
- public static boolean toBoolean(final Boolean bool) {
- return bool != null && bool.booleanValue();
- }
-
- /**
- * <p>Converts a Boolean to a boolean handling {@code null}.</p>
- *
- * <pre>
- * BooleanUtils.toBooleanDefaultIfNull(Boolean.TRUE, false) = true
- * BooleanUtils.toBooleanDefaultIfNull(Boolean.FALSE, true) = false
- * BooleanUtils.toBooleanDefaultIfNull(null, true) = true
- * </pre>
- *
- * @param bool the boolean to convert
- * @param valueIfNull the boolean value to return if {@code null}
- * @return {@code true} or {@code false}
- */
- public static boolean toBooleanDefaultIfNull(final Boolean bool, final boolean valueIfNull) {
- if (bool == null) {
- return valueIfNull;
- }
- return bool.booleanValue();
- }
-
- // Integer to Boolean methods
- //-----------------------------------------------------------------------
- /**
- * <p>Converts an int to a boolean using the convention that {@code zero}
- * is {@code false}.</p>
- *
- * <pre>
- * BooleanUtils.toBoolean(0) = false
- * BooleanUtils.toBoolean(1) = true
- * BooleanUtils.toBoolean(2) = true
- * </pre>
- *
- * @param value the int to convert
- * @return {@code true} if non-zero, {@code false}
- * if zero
- */
- public static boolean toBoolean(final int value) {
- return value != 0;
- }
-
- /**
- * <p>Converts an int to a Boolean using the convention that {@code zero}
- * is {@code false}.</p>
- *
- * <pre>
- * BooleanUtils.toBoolean(0) = Boolean.FALSE
- * BooleanUtils.toBoolean(1) = Boolean.TRUE
- * BooleanUtils.toBoolean(2) = Boolean.TRUE
- * </pre>
- *
- * @param value the int to convert
- * @return Boolean.TRUE if non-zero, Boolean.FALSE if zero,
- * {@code null} if {@code null}
- */
- public static Boolean toBooleanObject(final int value) {
- return value == 0 ? Boolean.FALSE : Boolean.TRUE;
- }
-
- /**
- * <p>Converts an Integer to a Boolean using the convention that {@code zero}
- * is {@code false}.</p>
- *
- * <p>{@code null} will be converted to {@code null}.</p>
- *
- * <p>NOTE: This returns null and will throw a NullPointerException if autoboxed to a boolean. </p>
- *
- * <pre>
- * BooleanUtils.toBoolean(Integer.valueOf(0)) = Boolean.FALSE
- * BooleanUtils.toBoolean(Integer.valueOf(1)) = Boolean.TRUE
- * BooleanUtils.toBoolean(Integer.valueOf(null)) = null
- * </pre>
- *
- * @param value the Integer to convert
- * @return Boolean.TRUE if non-zero, Boolean.FALSE if zero,
- * {@code null} if {@code null} input
- */
- public static Boolean toBooleanObject(final Integer value) {
- if (value == null) {
- return null;
- }
- return value.intValue() == 0 ? Boolean.FALSE : Boolean.TRUE;
- }
-
- /**
- * <p>Converts an int to a boolean specifying the conversion values.</p>
- *
- * <pre>
- * BooleanUtils.toBoolean(0, 1, 0) = false
- * BooleanUtils.toBoolean(1, 1, 0) = true
- * BooleanUtils.toBoolean(2, 1, 2) = false
- * BooleanUtils.toBoolean(2, 2, 0) = true
- * </pre>
- *
- * @param value the Integer to convert
- * @param trueValue the value to match for {@code true}
- * @param falseValue the value to match for {@code false}
- * @return {@code true} or {@code false}
- * @throws IllegalArgumentException if no match
- */
- public static boolean toBoolean(final int value, final int trueValue, final int falseValue) {
- if (value == trueValue) {
- return true;
- }
- if (value == falseValue) {
- return false;
- }
- // no match
- throw new IllegalArgumentException("The Integer did not match either specified value");
- }
-
- /**
- * <p>Converts an Integer to a boolean specifying the conversion values.</p>
- *
- * <pre>
- * BooleanUtils.toBoolean(Integer.valueOf(0), Integer.valueOf(1), Integer.valueOf(0)) = false
- * BooleanUtils.toBoolean(Integer.valueOf(1), Integer.valueOf(1), Integer.valueOf(0)) = true
- * BooleanUtils.toBoolean(Integer.valueOf(2), Integer.valueOf(1), Integer.valueOf(2)) = false
- * BooleanUtils.toBoolean(Integer.valueOf(2), Integer.valueOf(2), Integer.valueOf(0)) = true
- * BooleanUtils.toBoolean(null, null, Integer.valueOf(0)) = true
- * </pre>
- *
- * @param value the Integer to convert
- * @param trueValue the value to match for {@code true}, may be {@code null}
- * @param falseValue the value to match for {@code false}, may be {@code null}
- * @return {@code true} or {@code false}
- * @throws IllegalArgumentException if no match
- */
- public static boolean toBoolean(final Integer value, final Integer trueValue, final Integer falseValue) {
- if (value == null) {
- if (trueValue == null) {
- return true;
- }
- if (falseValue == null) {
- return false;
- }
- } else if (value.equals(trueValue)) {
- return true;
- } else if (value.equals(falseValue)) {
- return false;
- }
- // no match
- throw new IllegalArgumentException("The Integer did not match either specified value");
- }
-
- /**
- * <p>Converts an int to a Boolean specifying the conversion values.</p>
- *
- * <p>NOTE: This returns null and will throw a NullPointerException if autoboxed to a boolean. </p>
- *
- * <pre>
- * BooleanUtils.toBooleanObject(0, 0, 2, 3) = Boolean.TRUE
- * BooleanUtils.toBooleanObject(2, 1, 2, 3) = Boolean.FALSE
- * BooleanUtils.toBooleanObject(3, 1, 2, 3) = null
- * </pre>
- *
- * @param value the Integer to convert
- * @param trueValue the value to match for {@code true}
- * @param falseValue the value to match for {@code false}
- * @param nullValue the value to to match for {@code null}
- * @return Boolean.TRUE, Boolean.FALSE, or {@code null}
- * @throws IllegalArgumentException if no match
- */
- public static Boolean toBooleanObject(final int value, final int trueValue, final int falseValue, final int nullValue) {
- if (value == trueValue) {
- return Boolean.TRUE;
- }
- if (value == falseValue) {
- return Boolean.FALSE;
- }
- if (value == nullValue) {
- return null;
- }
- // no match
- throw new IllegalArgumentException("The Integer did not match any specified value");
- }
-
- /**
- * <p>Converts an Integer to a Boolean specifying the conversion values.</p>
- *
- * <p>NOTE: This returns null and will throw a NullPointerException if autoboxed to a boolean. </p>
- *
- * <pre>
- * BooleanUtils.toBooleanObject(Integer.valueOf(0), Integer.valueOf(0), Integer.valueOf(2), Integer.valueOf(3)) = Boolean.TRUE
- * BooleanUtils.toBooleanObject(Integer.valueOf(2), Integer.valueOf(1), Integer.valueOf(2), Integer.valueOf(3)) = Boolean.FALSE
- * BooleanUtils.toBooleanObject(Integer.valueOf(3), Integer.valueOf(1), Integer.valueOf(2), Integer.valueOf(3)) = null
- * </pre>
- *
- * @param value the Integer to convert
- * @param trueValue the value to match for {@code true}, may be {@code null}
- * @param falseValue the value to match for {@code false}, may be {@code null}
- * @param nullValue the value to to match for {@code null}, may be {@code null}
- * @return Boolean.TRUE, Boolean.FALSE, or {@code null}
- * @throws IllegalArgumentException if no match
- */
- public static Boolean toBooleanObject(final Integer value, final Integer trueValue, final Integer falseValue, final Integer nullValue) {
- if (value == null) {
- if (trueValue == null) {
- return Boolean.TRUE;
- }
- if (falseValue == null) {
- return Boolean.FALSE;
- }
- if (nullValue == null) {
- return null;
- }
- } else if (value.equals(trueValue)) {
- return Boolean.TRUE;
- } else if (value.equals(falseValue)) {
- return Boolean.FALSE;
- } else if (value.equals(nullValue)) {
- return null;
- }
- // no match
- throw new IllegalArgumentException("The Integer did not match any specified value");
- }
-
- // Boolean to Integer methods
- //-----------------------------------------------------------------------
- /**
- * <p>Converts a boolean to an int using the convention that
- * {@code zero} is {@code false}.</p>
- *
- * <pre>
- * BooleanUtils.toInteger(true) = 1
- * BooleanUtils.toInteger(false) = 0
- * </pre>
- *
- * @param bool the boolean to convert
- * @return one if {@code true}, zero if {@code false}
- */
- public static int toInteger(final boolean bool) {
- return bool ? 1 : 0;
- }
-
- /**
- * <p>Converts a boolean to an Integer using the convention that
- * {@code zero} is {@code false}.</p>
- *
- * <pre>
- * BooleanUtils.toIntegerObject(true) = Integer.valueOf(1)
- * BooleanUtils.toIntegerObject(false) = Integer.valueOf(0)
- * </pre>
- *
- * @param bool the boolean to convert
- * @return one if {@code true}, zero if {@code false}
- */
- public static Integer toIntegerObject(final boolean bool) {
- return bool ? NumberUtils.INTEGER_ONE : NumberUtils.INTEGER_ZERO;
- }
-
- /**
- * <p>Converts a Boolean to a Integer using the convention that
- * {@code zero} is {@code false}.</p>
- *
- * <p>{@code null} will be converted to {@code null}.</p>
- *
- * <pre>
- * BooleanUtils.toIntegerObject(Boolean.TRUE) = Integer.valueOf(1)
- * BooleanUtils.toIntegerObject(Boolean.FALSE) = Integer.valueOf(0)
- * </pre>
- *
- * @param bool the Boolean to convert
- * @return one if Boolean.TRUE, zero if Boolean.FALSE, {@code null} if {@code null}
- */
- public static Integer toIntegerObject(final Boolean bool) {
- if (bool == null) {
- return null;
- }
- return bool.booleanValue() ? NumberUtils.INTEGER_ONE : NumberUtils.INTEGER_ZERO;
- }
-
- /**
- * <p>Converts a boolean to an int specifying the conversion values.</p>
- *
- * <pre>
- * BooleanUtils.toInteger(true, 1, 0) = 1
- * BooleanUtils.toInteger(false, 1, 0) = 0
- * </pre>
- *
- * @param bool the to convert
- * @param trueValue the value to return if {@code true}
- * @param falseValue the value to return if {@code false}
- * @return the appropriate value
- */
- public static int toInteger(final boolean bool, final int trueValue, final int falseValue) {
- return bool ? trueValue : falseValue;
- }
-
- /**
- * <p>Converts a Boolean to an int specifying the conversion values.</p>
- *
- * <pre>
- * BooleanUtils.toInteger(Boolean.TRUE, 1, 0, 2) = 1
- * BooleanUtils.toInteger(Boolean.FALSE, 1, 0, 2) = 0
- * BooleanUtils.toInteger(null, 1, 0, 2) = 2
- * </pre>
- *
- * @param bool the Boolean to convert
- * @param trueValue the value to return if {@code true}
- * @param falseValue the value to return if {@code false}
- * @param nullValue the value to return if {@code null}
- * @return the appropriate value
- */
- public static int toInteger(final Boolean bool, final int trueValue, final int falseValue, final int nullValue) {
- if (bool == null) {
- return nullValue;
- }
- return bool.booleanValue() ? trueValue : falseValue;
- }
-
- /**
- * <p>Converts a boolean to an Integer specifying the conversion values.</p>
- *
- * <pre>
- * BooleanUtils.toIntegerObject(true, Integer.valueOf(1), Integer.valueOf(0)) = Integer.valueOf(1)
- * BooleanUtils.toIntegerObject(false, Integer.valueOf(1), Integer.valueOf(0)) = Integer.valueOf(0)
- * </pre>
- *
- * @param bool the to convert
- * @param trueValue the value to return if {@code true}, may be {@code null}
- * @param falseValue the value to return if {@code false}, may be {@code null}
- * @return the appropriate value
- */
- public static Integer toIntegerObject(final boolean bool, final Integer trueValue, final Integer falseValue) {
- return bool ? trueValue : falseValue;
- }
-
- /**
- * <p>Converts a Boolean to an Integer specifying the conversion values.</p>
- *
- * <pre>
- * BooleanUtils.toIntegerObject(Boolean.TRUE, Integer.valueOf(1), Integer.valueOf(0), Integer.valueOf(2)) = Integer.valueOf(1)
- * BooleanUtils.toIntegerObject(Boolean.FALSE, Integer.valueOf(1), Integer.valueOf(0), Integer.valueOf(2)) = Integer.valueOf(0)
- * BooleanUtils.toIntegerObject(null, Integer.valueOf(1), Integer.valueOf(0), Integer.valueOf(2)) = Integer.valueOf(2)
- * </pre>
- *
- * @param bool the Boolean to convert
- * @param trueValue the value to return if {@code true}, may be {@code null}
- * @param falseValue the value to return if {@code false}, may be {@code null}
- * @param nullValue the value to return if {@code null}, may be {@code null}
- * @return the appropriate value
- */
- public static Integer toIntegerObject(final Boolean bool, final Integer trueValue, final Integer falseValue, final Integer nullValue) {
- if (bool == null) {
- return nullValue;
- }
- return bool.booleanValue() ? trueValue : falseValue;
- }
-
- // String to Boolean methods
- //-----------------------------------------------------------------------
- /**
- * <p>Converts a String to a Boolean.</p>
- *
- * <p>{@code 'true'}, {@code 'on'}, {@code 'y'}, {@code 't'} or {@code 'yes'}
- * (case insensitive) will return {@code true}.
- * {@code 'false'}, {@code 'off'}, {@code 'n'}, {@code 'f'} or {@code 'no'}
- * (case insensitive) will return {@code false}.
- * Otherwise, {@code null} is returned.</p>
- *
- * <p>NOTE: This returns null and will throw a NullPointerException if autoboxed to a boolean. </p>
- *
- * <pre>
- * // N.B. case is not significant
- * BooleanUtils.toBooleanObject(null) = null
- * BooleanUtils.toBooleanObject("true") = Boolean.TRUE
- * BooleanUtils.toBooleanObject("T") = Boolean.TRUE // i.e. T[RUE]
- * BooleanUtils.toBooleanObject("false") = Boolean.FALSE
- * BooleanUtils.toBooleanObject("f") = Boolean.FALSE // i.e. f[alse]
- * BooleanUtils.toBooleanObject("No") = Boolean.FALSE
- * BooleanUtils.toBooleanObject("n") = Boolean.FALSE // i.e. n[o]
- * BooleanUtils.toBooleanObject("on") = Boolean.TRUE
- * BooleanUtils.toBooleanObject("ON") = Boolean.TRUE
- * BooleanUtils.toBooleanObject("off") = Boolean.FALSE
- * BooleanUtils.toBooleanObject("oFf") = Boolean.FALSE
- * BooleanUtils.toBooleanObject("yes") = Boolean.TRUE
- * BooleanUtils.toBooleanObject("Y") = Boolean.TRUE // i.e. Y[ES]
- * BooleanUtils.toBooleanObject("blue") = null
- * BooleanUtils.toBooleanObject("true ") = null // trailing space (too long)
- * BooleanUtils.toBooleanObject("ono") = null // does not match on or no
- * </pre>
- *
- * @param str the String to check; upper and lower case are treated as the same
- * @return the Boolean value of the string, {@code null} if no match or {@code null} input
- */
- public static Boolean toBooleanObject(final String str) {
- // Previously used equalsIgnoreCase, which was fast for interned 'true'.
- // Non interned 'true' matched 15 times slower.
- //
- // Optimisation provides same performance as before for interned 'true'.
- // Similar performance for null, 'false', and other strings not length 2/3/4.
- // 'true'/'TRUE' match 4 times slower, 'tRUE'/'True' 7 times slower.
- if (str == "true") {
- return Boolean.TRUE;
- }
- if (str == null) {
- return null;
- }
- switch (str.length()) {
- case 1: {
- final char ch0 = str.charAt(0);
- if (ch0 == 'y' || ch0 == 'Y' ||
- ch0 == 't' || ch0 == 'T') {
- return Boolean.TRUE;
- }
- if (ch0 == 'n' || ch0 == 'N' ||
- ch0 == 'f' || ch0 == 'F') {
- return Boolean.FALSE;
- }
- break;
- }
- case 2: {
- final char ch0 = str.charAt(0);
- final char ch1 = str.charAt(1);
- if ((ch0 == 'o' || ch0 == 'O') &&
- (ch1 == 'n' || ch1 == 'N') ) {
- return Boolean.TRUE;
- }
- if ((ch0 == 'n' || ch0 == 'N') &&
- (ch1 == 'o' || ch1 == 'O') ) {
- return Boolean.FALSE;
- }
- break;
- }
- case 3: {
- final char ch0 = str.charAt(0);
- final char ch1 = str.charAt(1);
- final char ch2 = str.charAt(2);
- if ((ch0 == 'y' || ch0 == 'Y') &&
- (ch1 == 'e' || ch1 == 'E') &&
- (ch2 == 's' || ch2 == 'S') ) {
- return Boolean.TRUE;
- }
- if ((ch0 == 'o' || ch0 == 'O') &&
- (ch1 == 'f' || ch1 == 'F') &&
- (ch2 == 'f' || ch2 == 'F') ) {
- return Boolean.FALSE;
- }
- break;
- }
- case 4: {
- final char ch0 = str.charAt(0);
- final char ch1 = str.charAt(1);
- final char ch2 = str.charAt(2);
- final char ch3 = str.charAt(3);
- if ((ch0 == 't' || ch0 == 'T') &&
- (ch1 == 'r' || ch1 == 'R') &&
- (ch2 == 'u' || ch2 == 'U') &&
- (ch3 == 'e' || ch3 == 'E') ) {
- return Boolean.TRUE;
- }
- break;
- }
- case 5: {
- final char ch0 = str.charAt(0);
- final char ch1 = str.charAt(1);
- final char ch2 = str.charAt(2);
- final char ch3 = str.charAt(3);
- final char ch4 = str.charAt(4);
- if ((ch0 == 'f' || ch0 == 'F') &&
- (ch1 == 'a' || ch1 == 'A') &&
- (ch2 == 'l' || ch2 == 'L') &&
- (ch3 == 's' || ch3 == 'S') &&
- (ch4 == 'e' || ch4 == 'E') ) {
- return Boolean.FALSE;
- }
- break;
- }
- default:
- break;
- }
-
- return null;
- }
-
- /**
- * <p>Converts a String to a Boolean throwing an exception if no match.</p>
- *
- * <p>NOTE: This returns null and will throw a NullPointerException if autoboxed to a boolean. </p>
- *
- * <pre>
- * BooleanUtils.toBooleanObject("true", "true", "false", "null") = Boolean.TRUE
- * BooleanUtils.toBooleanObject("false", "true", "false", "null") = Boolean.FALSE
- * BooleanUtils.toBooleanObject("null", "true", "false", "null") = null
- * </pre>
- *
- * @param str the String to check
- * @param trueString the String to match for {@code true} (case sensitive), may be {@code null}
- * @param falseString the String to match for {@code false} (case sensitive), may be {@code null}
- * @param nullString the String to match for {@code null} (case sensitive), may be {@code null}
- * @return the Boolean value of the string, {@code null} if either the String matches {@code nullString}
- * or if {@code null} input and {@code nullString} is {@code null}
- * @throws IllegalArgumentException if the String doesn't match
- */
- public static Boolean toBooleanObject(final String str, final String trueString, final String falseString, final String nullString) {
- if (str == null) {
- if (trueString == null) {
- return Boolean.TRUE;
- }
- if (falseString == null) {
- return Boolean.FALSE;
- }
- if (nullString == null) {
- return null;
- }
- } else if (str.equals(trueString)) {
- return Boolean.TRUE;
- } else if (str.equals(falseString)) {
- return Boolean.FALSE;
- } else if (str.equals(nullString)) {
- return null;
- }
- // no match
- throw new IllegalArgumentException("The String did not match any specified value");
- }
-
- // String to boolean methods
- //-----------------------------------------------------------------------
- /**
- * <p>Converts a String to a boolean (optimised for performance).</p>
- *
- * <p>{@code 'true'}, {@code 'on'}, {@code 'y'}, {@code 't'} or {@code 'yes'}
- * (case insensitive) will return {@code true}. Otherwise,
- * {@code false} is returned.</p>
- *
- * <p>This method performs 4 times faster (JDK1.4) than
- * {@code Boolean.valueOf(String)}. However, this method accepts
- * 'on' and 'yes', 't', 'y' as true values.
- *
- * <pre>
- * BooleanUtils.toBoolean(null) = false
- * BooleanUtils.toBoolean("true") = true
- * BooleanUtils.toBoolean("TRUE") = true
- * BooleanUtils.toBoolean("tRUe") = true
- * BooleanUtils.toBoolean("on") = true
- * BooleanUtils.toBoolean("yes") = true
- * BooleanUtils.toBoolean("false") = false
- * BooleanUtils.toBoolean("x gti") = false
- * BooleanUtils.toBooleanObject("y") = true
- * BooleanUtils.toBooleanObject("n") = false
- * BooleanUtils.toBooleanObject("t") = true
- * BooleanUtils.toBooleanObject("f") = false
- * </pre>
- *
- * @param str the String to check
- * @return the boolean value of the string, {@code false} if no match or the String is null
- */
- public static boolean toBoolean(final String str) {
- return toBooleanObject(str) == Boolean.TRUE;
- }
-
- /**
- * <p>Converts a String to a Boolean throwing an exception if no match found.</p>
- *
- * <pre>
- * BooleanUtils.toBoolean("true", "true", "false") = true
- * BooleanUtils.toBoolean("false", "true", "false") = false
- * </pre>
- *
- * @param str the String to check
- * @param trueString the String to match for {@code true} (case sensitive), may be {@code null}
- * @param falseString the String to match for {@code false} (case sensitive), may be {@code null}
- * @return the boolean value of the string
- * @throws IllegalArgumentException if the String doesn't match
- */
- public static boolean toBoolean(final String str, final String trueString, final String falseString) {
- if (str == trueString) {
- return true;
- } else if (str == falseString) {
- return false;
- } else if (str != null) {
- if (str.equals(trueString)) {
- return true;
- } else if (str.equals(falseString)) {
- return false;
- }
- }
- // no match
- throw new IllegalArgumentException("The String did not match either specified value");
- }
-
- // Boolean to String methods
- //-----------------------------------------------------------------------
- /**
- * <p>Converts a Boolean to a String returning {@code 'true'},
- * {@code 'false'}, or {@code null}.</p>
- *
- * <pre>
- * BooleanUtils.toStringTrueFalse(Boolean.TRUE) = "true"
- * BooleanUtils.toStringTrueFalse(Boolean.FALSE) = "false"
- * BooleanUtils.toStringTrueFalse(null) = null;
- * </pre>
- *
- * @param bool the Boolean to check
- * @return {@code 'true'}, {@code 'false'}, or {@code null}
- */
- public static String toStringTrueFalse(final Boolean bool) {
- return toString(bool, "true", "false", null);
- }
-
- /**
- * <p>Converts a Boolean to a String returning {@code 'on'},
- * {@code 'off'}, or {@code null}.</p>
- *
- * <pre>
- * BooleanUtils.toStringOnOff(Boolean.TRUE) = "on"
- * BooleanUtils.toStringOnOff(Boolean.FALSE) = "off"
- * BooleanUtils.toStringOnOff(null) = null;
- * </pre>
- *
- * @param bool the Boolean to check
- * @return {@code 'on'}, {@code 'off'}, or {@code null}
- */
- public static String toStringOnOff(final Boolean bool) {
- return toString(bool, "on", "off", null);
- }
-
- /**
- * <p>Converts a Boolean to a String returning {@code 'yes'},
- * {@code 'no'}, or {@code null}.</p>
- *
- * <pre>
- * BooleanUtils.toStringYesNo(Boolean.TRUE) = "yes"
- * BooleanUtils.toStringYesNo(Boolean.FALSE) = "no"
- * BooleanUtils.toStringYesNo(null) = null;
- * </pre>
- *
- * @param bool the Boolean to check
- * @return {@code 'yes'}, {@code 'no'}, or {@code null}
- */
- public static String toStringYesNo(final Boolean bool) {
- return toString(bool, "yes", "no", null);
- }
-
- /**
- * <p>Converts a Boolean to a String returning one of the input Strings.</p>
- *
- * <pre>
- * BooleanUtils.toString(Boolean.TRUE, "true", "false", null) = "true"
- * BooleanUtils.toString(Boolean.FALSE, "true", "false", null) = "false"
- * BooleanUtils.toString(null, "true", "false", null) = null;
- * </pre>
- *
- * @param bool the Boolean to check
- * @param trueString the String to return if {@code true}, may be {@code null}
- * @param falseString the String to return if {@code false}, may be {@code null}
- * @param nullString the String to return if {@code null}, may be {@code null}
- * @return one of the three input Strings
- */
- public static String toString(final Boolean bool, final String trueString, final String falseString, final String nullString) {
- if (bool == null) {
- return nullString;
- }
- return bool.booleanValue() ? trueString : falseString;
- }
-
- // boolean to String methods
- //-----------------------------------------------------------------------
- /**
- * <p>Converts a boolean to a String returning {@code 'true'}
- * or {@code 'false'}.</p>
- *
- * <pre>
- * BooleanUtils.toStringTrueFalse(true) = "true"
- * BooleanUtils.toStringTrueFalse(false) = "false"
- * </pre>
- *
- * @param bool the Boolean to check
- * @return {@code 'true'}, {@code 'false'}, or {@code null}
- */
- public static String toStringTrueFalse(final boolean bool) {
- return toString(bool, "true", "false");
- }
-
- /**
- * <p>Converts a boolean to a String returning {@code 'on'}
- * or {@code 'off'}.</p>
- *
- * <pre>
- * BooleanUtils.toStringOnOff(true) = "on"
- * BooleanUtils.toStringOnOff(false) = "off"
- * </pre>
- *
- * @param bool the Boolean to check
- * @return {@code 'on'}, {@code 'off'}, or {@code null}
- */
- public static String toStringOnOff(final boolean bool) {
- return toString(bool, "on", "off");
- }
-
- /**
- * <p>Converts a boolean to a String returning {@code 'yes'}
- * or {@code 'no'}.</p>
- *
- * <pre>
- * BooleanUtils.toStringYesNo(true) = "yes"
- * BooleanUtils.toStringYesNo(false) = "no"
- * </pre>
- *
- * @param bool the Boolean to check
- * @return {@code 'yes'}, {@code 'no'}, or {@code null}
- */
- public static String toStringYesNo(final boolean bool) {
- return toString(bool, "yes", "no");
- }
-
- /**
- * <p>Converts a boolean to a String returning one of the input Strings.</p>
- *
- * <pre>
- * BooleanUtils.toString(true, "true", "false") = "true"
- * BooleanUtils.toString(false, "true", "false") = "false"
- * </pre>
- *
- * @param bool the Boolean to check
- * @param trueString the String to return if {@code true}, may be {@code null}
- * @param falseString the String to return if {@code false}, may be {@code null}
- * @return one of the two input Strings
- */
- public static String toString(final boolean bool, final String trueString, final String falseString) {
- return bool ? trueString : falseString;
- }
-
- // logical operations
- // ----------------------------------------------------------------------
- /**
- * <p>Performs an and on a set of booleans.</p>
- *
- * <pre>
- * BooleanUtils.and(true, true) = true
- * BooleanUtils.and(false, false) = false
- * BooleanUtils.and(true, false) = false
- * BooleanUtils.and(true, true, false) = false
- * BooleanUtils.and(true, true, true) = true
- * </pre>
- *
- * @param array an array of {@code boolean}s
- * @return {@code true} if the and is successful.
- * @throws IllegalArgumentException if {@code array} is {@code null}
- * @throws IllegalArgumentException if {@code array} is empty.
- * @since 3.0.1
- */
- public static boolean and(final boolean... array) {
- // Validates input
- if (array == null) {
- throw new IllegalArgumentException("The Array must not be null");
- }
- if (array.length == 0) {
- throw new IllegalArgumentException("Array is empty");
- }
- for (final boolean element : array) {
- if (!element) {
- return false;
- }
- }
- return true;
- }
-
- /**
- * <p>Performs an and on an array of Booleans.</p>
- *
- * <pre>
- * BooleanUtils.and(Boolean.TRUE, Boolean.TRUE) = Boolean.TRUE
- * BooleanUtils.and(Boolean.FALSE, Boolean.FALSE) = Boolean.FALSE
- * BooleanUtils.and(Boolean.TRUE, Boolean.FALSE) = Boolean.FALSE
- * BooleanUtils.and(Boolean.TRUE, Boolean.TRUE, Boolean.TRUE) = Boolean.TRUE
- * BooleanUtils.and(Boolean.FALSE, Boolean.FALSE, Boolean.TRUE) = Boolean.FALSE
- * BooleanUtils.and(Boolean.TRUE, Boolean.FALSE, Boolean.TRUE) = Boolean.FALSE
- * </pre>
- *
- * @param array an array of {@code Boolean}s
- * @return {@code true} if the and is successful.
- * @throws IllegalArgumentException if {@code array} is {@code null}
- * @throws IllegalArgumentException if {@code array} is empty.
- * @throws IllegalArgumentException if {@code array} contains a {@code null}
- * @since 3.0.1
- */
- public static Boolean and(final Boolean... array) {
- if (array == null) {
- throw new IllegalArgumentException("The Array must not be null");
- }
- if (array.length == 0) {
- throw new IllegalArgumentException("Array is empty");
- }
- try {
- final boolean[] primitive = ArrayUtils.toPrimitive(array);
- return and(primitive) ? Boolean.TRUE : Boolean.FALSE;
- } catch (final NullPointerException ex) {
- throw new IllegalArgumentException("The array must not contain any null elements");
- }
- }
-
- /**
- * <p>Performs an or on a set of booleans.</p>
- *
- * <pre>
- * BooleanUtils.or(true, true) = true
- * BooleanUtils.or(false, false) = false
- * BooleanUtils.or(true, false) = true
- * BooleanUtils.or(true, true, false) = true
- * BooleanUtils.or(true, true, true) = true
- * BooleanUtils.or(false, false, false) = false
- * </pre>
- *
- * @param array an array of {@code boolean}s
- * @return {@code true} if the or is successful.
- * @throws IllegalArgumentException if {@code array} is {@code null}
- * @throws IllegalArgumentException if {@code array} is empty.
- * @since 3.0.1
- */
- public static boolean or(final boolean... array) {
- // Validates input
- if (array == null) {
- throw new IllegalArgumentException("The Array must not be null");
- }
- if (array.length == 0) {
- throw new IllegalArgumentException("Array is empty");
- }
- for (final boolean element : array) {
- if (element) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * <p>Performs an or on an array of Booleans.</p>
- *
- * <pre>
- * BooleanUtils.or(Boolean.TRUE, Boolean.TRUE) = Boolean.TRUE
- * BooleanUtils.or(Boolean.FALSE, Boolean.FALSE) = Boolean.FALSE
- * BooleanUtils.or(Boolean.TRUE, Boolean.FALSE) = Boolean.TRUE
- * BooleanUtils.or(Boolean.TRUE, Boolean.TRUE, Boolean.TRUE) = Boolean.TRUE
- * BooleanUtils.or(Boolean.FALSE, Boolean.FALSE, Boolean.TRUE) = Boolean.TRUE
- * BooleanUtils.or(Boolean.TRUE, Boolean.FALSE, Boolean.TRUE) = Boolean.TRUE
- * BooleanUtils.or(Boolean.FALSE, Boolean.FALSE, Boolean.FALSE) = Boolean.FALSE
- * </pre>
- *
- * @param array an array of {@code Boolean}s
- * @return {@code true} if the or is successful.
- * @throws IllegalArgumentException if {@code array} is {@code null}
- * @throws IllegalArgumentException if {@code array} is empty.
- * @throws IllegalArgumentException if {@code array} contains a {@code null}
- * @since 3.0.1
- */
- public static Boolean or(final Boolean... array) {
- if (array == null) {
- throw new IllegalArgumentException("The Array must not be null");
- }
- if (array.length == 0) {
- throw new IllegalArgumentException("Array is empty");
- }
- try {
- final boolean[] primitive = ArrayUtils.toPrimitive(array);
- return or(primitive) ? Boolean.TRUE : Boolean.FALSE;
- } catch (final NullPointerException ex) {
- throw new IllegalArgumentException("The array must not contain any null elements");
- }
- }
-
- /**
- * <p>Performs an xor on a set of booleans.</p>
- *
- * <pre>
- * BooleanUtils.xor(true, true) = false
- * BooleanUtils.xor(false, false) = false
- * BooleanUtils.xor(true, false) = true
- * BooleanUtils.xor(true, true) = false
- * BooleanUtils.xor(false, false) = false
- * BooleanUtils.xor(true, false) = true
- * </pre>
- *
- * @param array an array of {@code boolean}s
- * @return {@code true} if the xor is successful.
- * @throws IllegalArgumentException if {@code array} is {@code null}
- * @throws IllegalArgumentException if {@code array} is empty.
- */
- public static boolean xor(final boolean... array) {
- // Validates input
- if (array == null) {
- throw new IllegalArgumentException("The Array must not be null");
- }
- if (array.length == 0) {
- throw new IllegalArgumentException("Array is empty");
- }
-
- // false if the neutral element of the xor operator
- boolean result = false;
- for (final boolean element : array) {
- result ^= element;
- }
-
- return result;
- }
-
- /**
- * <p>Performs an xor on an array of Booleans.</p>
- *
- * <pre>
- * BooleanUtils.xor(new Boolean[] { Boolean.TRUE, Boolean.TRUE }) = Boolean.FALSE
- * BooleanUtils.xor(new Boolean[] { Boolean.FALSE, Boolean.FALSE }) = Boolean.FALSE
- * BooleanUtils.xor(new Boolean[] { Boolean.TRUE, Boolean.FALSE }) = Boolean.TRUE
- * </pre>
- *
- * @param array an array of {@code Boolean}s
- * @return {@code true} if the xor is successful.
- * @throws IllegalArgumentException if {@code array} is {@code null}
- * @throws IllegalArgumentException if {@code array} is empty.
- * @throws IllegalArgumentException if {@code array} contains a {@code null}
- */
- public static Boolean xor(final Boolean... array) {
- if (array == null) {
- throw new IllegalArgumentException("The Array must not be null");
- }
- if (array.length == 0) {
- throw new IllegalArgumentException("Array is empty");
- }
- try {
- final boolean[] primitive = ArrayUtils.toPrimitive(array);
- return xor(primitive) ? Boolean.TRUE : Boolean.FALSE;
- } catch (final NullPointerException ex) {
- throw new IllegalArgumentException("The array must not contain any null elements");
- }
- }
-
- /**
- * <p>Compares two {@code boolean} values. This is the same functionality as provided in Java 7.</p>
- *
- * @param x the first {@code boolean} to compare
- * @param y the second {@code boolean} to compare
- * @return the value {@code 0} if {@code x == y};
- * a value less than {@code 0} if {@code !x && y}; and
- * a value greater than {@code 0} if {@code x && !y}
- * @since 3.4
- */
- public static int compare(boolean x, boolean y) {
- if (x == y) {
- return 0;
- }
- return x ? 1 : -1;
- }
-
-}
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.commons.lang3;
+
+import org.apache.commons.lang3.math.NumberUtils;
+
+/**
+ * <p>Operations on boolean primitives and Boolean objects.</p>
+ *
+ * <p>This class tries to handle {@code null} input gracefully.
+ * An exception will not be thrown for a {@code null} input.
+ * Each method documents its behaviour in more detail.</p>
+ *
+ * <p>#ThreadSafe#</p>
+ * @since 2.0
+ */
+public class BooleanUtils {
+
+ /**
+ * <p>{@code BooleanUtils} instances should NOT be constructed in standard programming.
+ * Instead, the class should be used as {@code BooleanUtils.negate(true);}.</p>
+ *
+ * <p>This constructor is public to permit tools that require a JavaBean instance
+ * to operate.</p>
+ */
+ public BooleanUtils() {
+ super();
+ }
+
+ // Boolean utilities
+ //--------------------------------------------------------------------------
+ /**
+ * <p>Negates the specified boolean.</p>
+ *
+ * <p>If {@code null} is passed in, {@code null} will be returned.</p>
+ *
+ * <p>NOTE: This returns null and will throw a NullPointerException if autoboxed to a boolean. </p>
+ *
+ * <pre>
+ * BooleanUtils.negate(Boolean.TRUE) = Boolean.FALSE;
+ * BooleanUtils.negate(Boolean.FALSE) = Boolean.TRUE;
+ * BooleanUtils.negate(null) = null;
+ * </pre>
+ *
+ * @param bool the Boolean to negate, may be null
+ * @return the negated Boolean, or {@code null} if {@code null} input
+ */
+ public static Boolean negate(final Boolean bool) {
+ if (bool == null) {
+ return null;
+ }
+ return bool.booleanValue() ? Boolean.FALSE : Boolean.TRUE;
+ }
+
+ // boolean Boolean methods
+ //-----------------------------------------------------------------------
+ /**
+ * <p>Checks if a {@code Boolean} value is {@code true},
+ * handling {@code null} by returning {@code false}.</p>
+ *
+ * <pre>
+ * BooleanUtils.isTrue(Boolean.TRUE) = true
+ * BooleanUtils.isTrue(Boolean.FALSE) = false
+ * BooleanUtils.isTrue(null) = false
+ * </pre>
+ *
+ * @param bool the boolean to check, null returns {@code false}
+ * @return {@code true} only if the input is non-null and true
+ * @since 2.1
+ */
+ public static boolean isTrue(final Boolean bool) {
+ return Boolean.TRUE.equals(bool);
+ }
+
+ /**
+ * <p>Checks if a {@code Boolean} value is <i>not</i> {@code true},
+ * handling {@code null} by returning {@code true}.</p>
+ *
+ * <pre>
+ * BooleanUtils.isNotTrue(Boolean.TRUE) = false
+ * BooleanUtils.isNotTrue(Boolean.FALSE) = true
+ * BooleanUtils.isNotTrue(null) = true
+ * </pre>
+ *
+ * @param bool the boolean to check, null returns {@code true}
+ * @return {@code true} if the input is null or false
+ * @since 2.3
+ */
+ public static boolean isNotTrue(final Boolean bool) {
+ return !isTrue(bool);
+ }
+
+ /**
+ * <p>Checks if a {@code Boolean} value is {@code false},
+ * handling {@code null} by returning {@code false}.</p>
+ *
+ * <pre>
+ * BooleanUtils.isFalse(Boolean.TRUE) = false
+ * BooleanUtils.isFalse(Boolean.FALSE) = true
+ * BooleanUtils.isFalse(null) = false
+ * </pre>
+ *
+ * @param bool the boolean to check, null returns {@code false}
+ * @return {@code true} only if the input is non-null and false
+ * @since 2.1
+ */
+ public static boolean isFalse(final Boolean bool) {
+ return Boolean.FALSE.equals(bool);
+ }
+
+ /**
+ * <p>Checks if a {@code Boolean} value is <i>not</i> {@code false},
+ * handling {@code null} by returning {@code true}.</p>
+ *
+ * <pre>
+ * BooleanUtils.isNotFalse(Boolean.TRUE) = true
+ * BooleanUtils.isNotFalse(Boolean.FALSE) = false
+ * BooleanUtils.isNotFalse(null) = true
+ * </pre>
+ *
+ * @param bool the boolean to check, null returns {@code true}
+ * @return {@code true} if the input is null or true
+ * @since 2.3
+ */
+ public static boolean isNotFalse(final Boolean bool) {
+ return !isFalse(bool);
+ }
+
+ //-----------------------------------------------------------------------
+ /**
+ * <p>Converts a Boolean to a boolean handling {@code null}
+ * by returning {@code false}.</p>
+ *
+ * <pre>
+ * BooleanUtils.toBoolean(Boolean.TRUE) = true
+ * BooleanUtils.toBoolean(Boolean.FALSE) = false
+ * BooleanUtils.toBoolean(null) = false
+ * </pre>
+ *
+ * @param bool the boolean to convert
+ * @return {@code true} or {@code false}, {@code null} returns {@code false}
+ */
+ public static boolean toBoolean(final Boolean bool) {
+ return bool != null && bool.booleanValue();
+ }
+
+ /**
+ * <p>Converts a Boolean to a boolean handling {@code null}.</p>
+ *
+ * <pre>
+ * BooleanUtils.toBooleanDefaultIfNull(Boolean.TRUE, false) = true
+ * BooleanUtils.toBooleanDefaultIfNull(Boolean.FALSE, true) = false
+ * BooleanUtils.toBooleanDefaultIfNull(null, true) = true
+ * </pre>
+ *
+ * @param bool the boolean to convert
+ * @param valueIfNull the boolean value to return if {@code null}
+ * @return {@code true} or {@code false}
+ */
+ public static boolean toBooleanDefaultIfNull(final Boolean bool, final boolean valueIfNull) {
+ if (bool == null) {
+ return valueIfNull;
+ }
+ return bool.booleanValue();
+ }
+
+ // Integer to Boolean methods
+ //-----------------------------------------------------------------------
+ /**
+ * <p>Converts an int to a boolean using the convention that {@code zero}
+ * is {@code false}.</p>
+ *
+ * <pre>
+ * BooleanUtils.toBoolean(0) = false
+ * BooleanUtils.toBoolean(1) = true
+ * BooleanUtils.toBoolean(2) = true
+ * </pre>
+ *
+ * @param value the int to convert
+ * @return {@code true} if non-zero, {@code false}
+ * if zero
+ */
+ public static boolean toBoolean(final int value) {
+ return value != 0;
+ }
+
+ /**
+ * <p>Converts an int to a Boolean using the convention that {@code zero}
+ * is {@code false}.</p>
+ *
+ * <pre>
+ * BooleanUtils.toBoolean(0) = Boolean.FALSE
+ * BooleanUtils.toBoolean(1) = Boolean.TRUE
+ * BooleanUtils.toBoolean(2) = Boolean.TRUE
+ * </pre>
+ *
+ * @param value the int to convert
+ * @return Boolean.TRUE if non-zero, Boolean.FALSE if zero,
+ * {@code null} if {@code null}
+ */
+ public static Boolean toBooleanObject(final int value) {
+ return value == 0 ? Boolean.FALSE : Boolean.TRUE;
+ }
+
+ /**
+ * <p>Converts an Integer to a Boolean using the convention that {@code zero}
+ * is {@code false}.</p>
+ *
+ * <p>{@code null} will be converted to {@code null}.</p>
+ *
+ * <p>NOTE: This returns null and will throw a NullPointerException if autoboxed to a boolean. </p>
+ *
+ * <pre>
+ * BooleanUtils.toBoolean(Integer.valueOf(0)) = Boolean.FALSE
+ * BooleanUtils.toBoolean(Integer.valueOf(1)) = Boolean.TRUE
+ * BooleanUtils.toBoolean(Integer.valueOf(null)) = null
+ * </pre>
+ *
+ * @param value the Integer to convert
+ * @return Boolean.TRUE if non-zero, Boolean.FALSE if zero,
+ * {@code null} if {@code null} input
+ */
+ public static Boolean toBooleanObject(final Integer value) {
+ if (value == null) {
+ return null;
+ }
+ return value.intValue() == 0 ? Boolean.FALSE : Boolean.TRUE;
+ }
+
+ /**
+ * <p>Converts an int to a boolean specifying the conversion values.</p>
+ *
+ * <pre>
+ * BooleanUtils.toBoolean(0, 1, 0) = false
+ * BooleanUtils.toBoolean(1, 1, 0) = true
+ * BooleanUtils.toBoolean(2, 1, 2) = false
+ * BooleanUtils.toBoolean(2, 2, 0) = true
+ * </pre>
+ *
+ * @param value the Integer to convert
+ * @param trueValue the value to match for {@code true}
+ * @param falseValue the value to match for {@code false}
+ * @return {@code true} or {@code false}
+ * @throws IllegalArgumentException if no match
+ */
+ public static boolean toBoolean(final int value, final int trueValue, final int falseValue) {
+ if (value == trueValue) {
+ return true;
+ }
+ if (value == falseValue) {
+ return false;
+ }
+ // no match
+ throw new IllegalArgumentException("The Integer did not match either specified value");
+ }
+
+ /**
+ * <p>Converts an Integer to a boolean specifying the conversion values.</p>
+ *
+ * <pre>
+ * BooleanUtils.toBoolean(Integer.valueOf(0), Integer.valueOf(1), Integer.valueOf(0)) = false
+ * BooleanUtils.toBoolean(Integer.valueOf(1), Integer.valueOf(1), Integer.valueOf(0)) = true
+ * BooleanUtils.toBoolean(Integer.valueOf(2), Integer.valueOf(1), Integer.valueOf(2)) = false
+ * BooleanUtils.toBoolean(Integer.valueOf(2), Integer.valueOf(2), Integer.valueOf(0)) = true
+ * BooleanUtils.toBoolean(null, null, Integer.valueOf(0)) = true
+ * </pre>
+ *
+ * @param value the Integer to convert
+ * @param trueValue the value to match for {@code true}, may be {@code null}
+ * @param falseValue the value to match for {@code false}, may be {@code null}
+ * @return {@code true} or {@code false}
+ * @throws IllegalArgumentException if no match
+ */
+ public static boolean toBoolean(final Integer value, final Integer trueValue, final Integer falseValue) {
+ if (value == null) {
+ if (trueValue == null) {
+ return true;
+ }
+ if (falseValue == null) {
+ return false;
+ }
+ } else if (value.equals(trueValue)) {
+ return true;
+ } else if (value.equals(falseValue)) {
+ return false;
+ }
+ // no match
+ throw new IllegalArgumentException("The Integer did not match either specified value");
+ }
+
+ /**
+ * <p>Converts an int to a Boolean specifying the conversion values.</p>
+ *
+ * <p>NOTE: This returns null and will throw a NullPointerException if autoboxed to a boolean. </p>
+ *
+ * <pre>
+ * BooleanUtils.toBooleanObject(0, 0, 2, 3) = Boolean.TRUE
+ * BooleanUtils.toBooleanObject(2, 1, 2, 3) = Boolean.FALSE
+ * BooleanUtils.toBooleanObject(3, 1, 2, 3) = null
+ * </pre>
+ *
+ * @param value the Integer to convert
+ * @param trueValue the value to match for {@code true}
+ * @param falseValue the value to match for {@code false}
+ * @param nullValue the value to to match for {@code null}
+ * @return Boolean.TRUE, Boolean.FALSE, or {@code null}
+ * @throws IllegalArgumentException if no match
+ */
+ public static Boolean toBooleanObject(final int value, final int trueValue, final int falseValue, final int nullValue) {
+ if (value == trueValue) {
+ return Boolean.TRUE;
+ }
+ if (value == falseValue) {
+ return Boolean.FALSE;
+ }
+ if (value == nullValue) {
+ return null;
+ }
+ // no match
+ throw new IllegalArgumentException("The Integer did not match any specified value");
+ }
+
+ /**
+ * <p>Converts an Integer to a Boolean specifying the conversion values.</p>
+ *
+ * <p>NOTE: This returns null and will throw a NullPointerException if autoboxed to a boolean. </p>
+ *
+ * <pre>
+ * BooleanUtils.toBooleanObject(Integer.valueOf(0), Integer.valueOf(0), Integer.valueOf(2), Integer.valueOf(3)) = Boolean.TRUE
+ * BooleanUtils.toBooleanObject(Integer.valueOf(2), Integer.valueOf(1), Integer.valueOf(2), Integer.valueOf(3)) = Boolean.FALSE
+ * BooleanUtils.toBooleanObject(Integer.valueOf(3), Integer.valueOf(1), Integer.valueOf(2), Integer.valueOf(3)) = null
+ * </pre>
+ *
+ * @param value the Integer to convert
+ * @param trueValue the value to match for {@code true}, may be {@code null}
+ * @param falseValue the value to match for {@code false}, may be {@code null}
+ * @param nullValue the value to to match for {@code null}, may be {@code null}
+ * @return Boolean.TRUE, Boolean.FALSE, or {@code null}
+ * @throws IllegalArgumentException if no match
+ */
+ public static Boolean toBooleanObject(final Integer value, final Integer trueValue, final Integer falseValue, final Integer nullValue) {
+ if (value == null) {
+ if (trueValue == null) {
+ return Boolean.TRUE;
+ }
+ if (falseValue == null) {
+ return Boolean.FALSE;
+ }
+ if (nullValue == null) {
+ return null;
+ }
+ } else if (value.equals(trueValue)) {
+ return Boolean.TRUE;
+ } else if (value.equals(falseValue)) {
+ return Boolean.FALSE;
+ } else if (value.equals(nullValue)) {
+ return null;
+ }
+ // no match
+ throw new IllegalArgumentException("The Integer did not match any specified value");
+ }
+
+ // Boolean to Integer methods
+ //-----------------------------------------------------------------------
+ /**
+ * <p>Converts a boolean to an int using the convention that
+ * {@code zero} is {@code false}.</p>
+ *
+ * <pre>
+ * BooleanUtils.toInteger(true) = 1
+ * BooleanUtils.toInteger(false) = 0
+ * </pre>
+ *
+ * @param bool the boolean to convert
+ * @return one if {@code true}, zero if {@code false}
+ */
+ public static int toInteger(final boolean bool) {
+ return bool ? 1 : 0;
+ }
+
+ /**
+ * <p>Converts a boolean to an Integer using the convention that
+ * {@code zero} is {@code false}.</p>
+ *
+ * <pre>
+ * BooleanUtils.toIntegerObject(true) = Integer.valueOf(1)
+ * BooleanUtils.toIntegerObject(false) = Integer.valueOf(0)
+ * </pre>
+ *
+ * @param bool the boolean to convert
+ * @return one if {@code true}, zero if {@code false}
+ */
+ public static Integer toIntegerObject(final boolean bool) {
+ return bool ? NumberUtils.INTEGER_ONE : NumberUtils.INTEGER_ZERO;
+ }
+
+ /**
+ * <p>Converts a Boolean to a Integer using the convention that
+ * {@code zero} is {@code false}.</p>
+ *
+ * <p>{@code null} will be converted to {@code null}.</p>
+ *
+ * <pre>
+ * BooleanUtils.toIntegerObject(Boolean.TRUE) = Integer.valueOf(1)
+ * BooleanUtils.toIntegerObject(Boolean.FALSE) = Integer.valueOf(0)
+ * </pre>
+ *
+ * @param bool the Boolean to convert
+ * @return one if Boolean.TRUE, zero if Boolean.FALSE, {@code null} if {@code null}
+ */
+ public static Integer toIntegerObject(final Boolean bool) {
+ if (bool == null) {
+ return null;
+ }
+ return bool.booleanValue() ? NumberUtils.INTEGER_ONE : NumberUtils.INTEGER_ZERO;
+ }
+
+ /**
+ * <p>Converts a boolean to an int specifying the conversion values.</p>
+ *
+ * <pre>
+ * BooleanUtils.toInteger(true, 1, 0) = 1
+ * BooleanUtils.toInteger(false, 1, 0) = 0
+ * </pre>
+ *
+ * @param bool the to convert
+ * @param trueValue the value to return if {@code true}
+ * @param falseValue the value to return if {@code false}
+ * @return the appropriate value
+ */
+ public static int toInteger(final boolean bool, final int trueValue, final int falseValue) {
+ return bool ? trueValue : falseValue;
+ }
+
+ /**
+ * <p>Converts a Boolean to an int specifying the conversion values.</p>
+ *
+ * <pre>
+ * BooleanUtils.toInteger(Boolean.TRUE, 1, 0, 2) = 1
+ * BooleanUtils.toInteger(Boolean.FALSE, 1, 0, 2) = 0
+ * BooleanUtils.toInteger(null, 1, 0, 2) = 2
+ * </pre>
+ *
+ * @param bool the Boolean to convert
+ * @param trueValue the value to return if {@code true}
+ * @param falseValue the value to return if {@code false}
+ * @param nullValue the value to return if {@code null}
+ * @return the appropriate value
+ */
+ public static int toInteger(final Boolean bool, final int trueValue, final int falseValue, final int nullValue) {
+ if (bool == null) {
+ return nullValue;
+ }
+ return bool.booleanValue() ? trueValue : falseValue;
+ }
+
+ /**
+ * <p>Converts a boolean to an Integer specifying the conversion values.</p>
+ *
+ * <pre>
+ * BooleanUtils.toIntegerObject(true, Integer.valueOf(1), Integer.valueOf(0)) = Integer.valueOf(1)
+ * BooleanUtils.toIntegerObject(false, Integer.valueOf(1), Integer.valueOf(0)) = Integer.valueOf(0)
+ * </pre>
+ *
+ * @param bool the to convert
+ * @param trueValue the value to return if {@code true}, may be {@code null}
+ * @param falseValue the value to return if {@code false}, may be {@code null}
+ * @return the appropriate value
+ */
+ public static Integer toIntegerObject(final boolean bool, final Integer trueValue, final Integer falseValue) {
+ return bool ? trueValue : falseValue;
+ }
+
+ /**
+ * <p>Converts a Boolean to an Integer specifying the conversion values.</p>
+ *
+ * <pre>
+ * BooleanUtils.toIntegerObject(Boolean.TRUE, Integer.valueOf(1), Integer.valueOf(0), Integer.valueOf(2)) = Integer.valueOf(1)
+ * BooleanUtils.toIntegerObject(Boolean.FALSE, Integer.valueOf(1), Integer.valueOf(0), Integer.valueOf(2)) = Integer.valueOf(0)
+ * BooleanUtils.toIntegerObject(null, Integer.valueOf(1), Integer.valueOf(0), Integer.valueOf(2)) = Integer.valueOf(2)
+ * </pre>
+ *
+ * @param bool the Boolean to convert
+ * @param trueValue the value to return if {@code true}, may be {@code null}
+ * @param falseValue the value to return if {@code false}, may be {@code null}
+ * @param nullValue the value to return if {@code null}, may be {@code null}
+ * @return the appropriate value
+ */
+ public static Integer toIntegerObject(final Boolean bool, final Integer trueValue, final Integer falseValue, final Integer nullValue) {
+ if (bool == null) {
+ return nullValue;
+ }
+ return bool.booleanValue() ? trueValue : falseValue;
+ }
+
+ // String to Boolean methods
+ //-----------------------------------------------------------------------
+ /**
+ * <p>Converts a String to a Boolean.</p>
+ *
+ * <p>{@code 'true'}, {@code 'on'}, {@code 'y'}, {@code 't'} or {@code 'yes'}
+ * (case insensitive) will return {@code true}.
+ * {@code 'false'}, {@code 'off'}, {@code 'n'}, {@code 'f'} or {@code 'no'}
+ * (case insensitive) will return {@code false}.
+ * Otherwise, {@code null} is returned.</p>
+ *
+ * <p>NOTE: This returns null and will throw a NullPointerException if autoboxed to a boolean. </p>
+ *
+ * <pre>
+ * // N.B. case is not significant
+ * BooleanUtils.toBooleanObject(null) = null
+ * BooleanUtils.toBooleanObject("true") = Boolean.TRUE
+ * BooleanUtils.toBooleanObject("T") = Boolean.TRUE // i.e. T[RUE]
+ * BooleanUtils.toBooleanObject("false") = Boolean.FALSE
+ * BooleanUtils.toBooleanObject("f") = Boolean.FALSE // i.e. f[alse]
+ * BooleanUtils.toBooleanObject("No") = Boolean.FALSE
+ * BooleanUtils.toBooleanObject("n") = Boolean.FALSE // i.e. n[o]
+ * BooleanUtils.toBooleanObject("on") = Boolean.TRUE
+ * BooleanUtils.toBooleanObject("ON") = Boolean.TRUE
+ * BooleanUtils.toBooleanObject("off") = Boolean.FALSE
+ * BooleanUtils.toBooleanObject("oFf") = Boolean.FALSE
+ * BooleanUtils.toBooleanObject("yes") = Boolean.TRUE
+ * BooleanUtils.toBooleanObject("Y") = Boolean.TRUE // i.e. Y[ES]
+ * BooleanUtils.toBooleanObject("blue") = null
+ * BooleanUtils.toBooleanObject("true ") = null // trailing space (too long)
+ * BooleanUtils.toBooleanObject("ono") = null // does not match on or no
+ * </pre>
+ *
+ * @param str the String to check; upper and lower case are treated as the same
+ * @return the Boolean value of the string, {@code null} if no match or {@code null} input
+ */
+ public static Boolean toBooleanObject(final String str) {
+ // Previously used equalsIgnoreCase, which was fast for interned 'true'.
+ // Non interned 'true' matched 15 times slower.
+ //
+ // Optimisation provides same performance as before for interned 'true'.
+ // Similar performance for null, 'false', and other strings not length 2/3/4.
+ // 'true'/'TRUE' match 4 times slower, 'tRUE'/'True' 7 times slower.
+ if (str == "true") {
+ return Boolean.TRUE;
+ }
+ if (str == null) {
+ return null;
+ }
+ switch (str.length()) {
+ case 1: {
+ final char ch0 = str.charAt(0);
+ if (ch0 == 'y' || ch0 == 'Y' ||
+ ch0 == 't' || ch0 == 'T') {
+ return Boolean.TRUE;
+ }
+ if (ch0 == 'n' || ch0 == 'N' ||
+ ch0 == 'f' || ch0 == 'F') {
+ return Boolean.FALSE;
+ }
+ break;
+ }
+ case 2: {
+ final char ch0 = str.charAt(0);
+ final char ch1 = str.charAt(1);
+ if ((ch0 == 'o' || ch0 == 'O') &&
+ (ch1 == 'n' || ch1 == 'N') ) {
+ return Boolean.TRUE;
+ }
+ if ((ch0 == 'n' || ch0 == 'N') &&
+ (ch1 == 'o' || ch1 == 'O') ) {
+ return Boolean.FALSE;
+ }
+ break;
+ }
+ case 3: {
+ final char ch0 = str.charAt(0);
+ final char ch1 = str.charAt(1);
+ final char ch2 = str.charAt(2);
+ if ((ch0 == 'y' || ch0 == 'Y') &&
+ (ch1 == 'e' || ch1 == 'E') &&
+ (ch2 == 's' || ch2 == 'S') ) {
+ return Boolean.TRUE;
+ }
+ if ((ch0 == 'o' || ch0 == 'O') &&
+ (ch1 == 'f' || ch1 == 'F') &&
+ (ch2 == 'f' || ch2 == 'F') ) {
+ return Boolean.FALSE;
+ }
+ break;
+ }
+ case 4: {
+ final char ch0 = str.charAt(0);
+ final char ch1 = str.charAt(1);
+ final char ch2 = str.charAt(2);
+ final char ch3 = str.charAt(3);
+ if ((ch0 == 't' || ch0 == 'T') &&
+ (ch1 == 'r' || ch1 == 'R') &&
+ (ch2 == 'u' || ch2 == 'U') &&
+ (ch3 == 'e' || ch3 == 'E') ) {
+ return Boolean.TRUE;
+ }
+ break;
+ }
+ case 5: {
+ final char ch0 = str.charAt(0);
+ final char ch1 = str.charAt(1);
+ final char ch2 = str.charAt(2);
+ final char ch3 = str.charAt(3);
+ final char ch4 = str.charAt(4);
+ if ((ch0 == 'f' || ch0 == 'F') &&
+ (ch1 == 'a' || ch1 == 'A') &&
+ (ch2 == 'l' || ch2 == 'L') &&
+ (ch3 == 's' || ch3 == 'S') &&
+ (ch4 == 'e' || ch4 == 'E') ) {
+ return Boolean.FALSE;
+ }
+ break;
+ }
+ default:
+ break;
+ }
+
+ return null;
+ }
+
+ /**
+ * <p>Converts a String to a Boolean throwing an exception if no match.</p>
+ *
+ * <p>NOTE: This returns null and will throw a NullPointerException if autoboxed to a boolean. </p>
+ *
+ * <pre>
+ * BooleanUtils.toBooleanObject("true", "true", "false", "null") = Boolean.TRUE
+ * BooleanUtils.toBooleanObject("false", "true", "false", "null") = Boolean.FALSE
+ * BooleanUtils.toBooleanObject("null", "true", "false", "null") = null
+ * </pre>
+ *
+ * @param str the String to check
+ * @param trueString the String to match for {@code true} (case sensitive), may be {@code null}
+ * @param falseString the String to match for {@code false} (case sensitive), may be {@code null}
+ * @param nullString the String to match for {@code null} (case sensitive), may be {@code null}
+ * @return the Boolean value of the string, {@code null} if either the String matches {@code nullString}
+ * or if {@code null} input and {@code nullString} is {@code null}
+ * @throws IllegalArgumentException if the String doesn't match
+ */
+ public static Boolean toBooleanObject(final String str, final String trueString, final String falseString, final String nullString) {
+ if (str == null) {
+ if (trueString == null) {
+ return Boolean.TRUE;
+ }
+ if (falseString == null) {
+ return Boolean.FALSE;
+ }
+ if (nullString == null) {
+ return null;
+ }
+ } else if (str.equals(trueString)) {
+ return Boolean.TRUE;
+ } else if (str.equals(falseString)) {
+ return Boolean.FALSE;
+ } else if (str.equals(nullString)) {
+ return null;
+ }
+ // no match
+ throw new IllegalArgumentException("The String did not match any specified value");
+ }
+
+ // String to boolean methods
+ //-----------------------------------------------------------------------
+ /**
+ * <p>Converts a String to a boolean (optimised for performance).</p>
+ *
+ * <p>{@code 'true'}, {@code 'on'}, {@code 'y'}, {@code 't'} or {@code 'yes'}
+ * (case insensitive) will return {@code true}. Otherwise,
+ * {@code false} is returned.</p>
+ *
+ * <p>This method performs 4 times faster (JDK1.4) than
+ * {@code Boolean.valueOf(String)}. However, this method accepts
+ * 'on' and 'yes', 't', 'y' as true values.
+ *
+ * <pre>
+ * BooleanUtils.toBoolean(null) = false
+ * BooleanUtils.toBoolean("true") = true
+ * BooleanUtils.toBoolean("TRUE") = true
+ * BooleanUtils.toBoolean("tRUe") = true
+ * BooleanUtils.toBoolean("on") = true
+ * BooleanUtils.toBoolean("yes") = true
+ * BooleanUtils.toBoolean("false") = false
+ * BooleanUtils.toBoolean("x gti") = false
+ * BooleanUtils.toBooleanObject("y") = true
+ * BooleanUtils.toBooleanObject("n") = false
+ * BooleanUtils.toBooleanObject("t") = true
+ * BooleanUtils.toBooleanObject("f") = false
+ * </pre>
+ *
+ * @param str the String to check
+ * @return the boolean value of the string, {@code false} if no match or the String is null
+ */
+ public static boolean toBoolean(final String str) {
+ return toBooleanObject(str) == Boolean.TRUE;
+ }
+
+ /**
+ * <p>Converts a String to a Boolean throwing an exception if no match found.</p>
+ *
+ * <pre>
+ * BooleanUtils.toBoolean("true", "true", "false") = true
+ * BooleanUtils.toBoolean("false", "true", "false") = false
+ * </pre>
+ *
+ * @param str the String to check
+ * @param trueString the String to match for {@code true} (case sensitive), may be {@code null}
+ * @param falseString the String to match for {@code false} (case sensitive), may be {@code null}
+ * @return the boolean value of the string
+ * @throws IllegalArgumentException if the String doesn't match
+ */
+ public static boolean toBoolean(final String str, final String trueString, final String falseString) {
+ if (str == trueString) {
+ return true;
+ } else if (str == falseString) {
+ return false;
+ } else if (str != null) {
+ if (str.equals(trueString)) {
+ return true;
+ } else if (str.equals(falseString)) {
+ return false;
+ }
+ }
+ // no match
+ throw new IllegalArgumentException("The String did not match either specified value");
+ }
+
+ // Boolean to String methods
+ //-----------------------------------------------------------------------
+ /**
+ * <p>Converts a Boolean to a String returning {@code 'true'},
+ * {@code 'false'}, or {@code null}.</p>
+ *
+ * <pre>
+ * BooleanUtils.toStringTrueFalse(Boolean.TRUE) = "true"
+ * BooleanUtils.toStringTrueFalse(Boolean.FALSE) = "false"
+ * BooleanUtils.toStringTrueFalse(null) = null;
+ * </pre>
+ *
+ * @param bool the Boolean to check
+ * @return {@code 'true'}, {@code 'false'}, or {@code null}
+ */
+ public static String toStringTrueFalse(final Boolean bool) {
+ return toString(bool, "true", "false", null);
+ }
+
+ /**
+ * <p>Converts a Boolean to a String returning {@code 'on'},
+ * {@code 'off'}, or {@code null}.</p>
+ *
+ * <pre>
+ * BooleanUtils.toStringOnOff(Boolean.TRUE) = "on"
+ * BooleanUtils.toStringOnOff(Boolean.FALSE) = "off"
+ * BooleanUtils.toStringOnOff(null) = null;
+ * </pre>
+ *
+ * @param bool the Boolean to check
+ * @return {@code 'on'}, {@code 'off'}, or {@code null}
+ */
+ public static String toStringOnOff(final Boolean bool) {
+ return toString(bool, "on", "off", null);
+ }
+
+ /**
+ * <p>Converts a Boolean to a String returning {@code 'yes'},
+ * {@code 'no'}, or {@code null}.</p>
+ *
+ * <pre>
+ * BooleanUtils.toStringYesNo(Boolean.TRUE) = "yes"
+ * BooleanUtils.toStringYesNo(Boolean.FALSE) = "no"
+ * BooleanUtils.toStringYesNo(null) = null;
+ * </pre>
+ *
+ * @param bool the Boolean to check
+ * @return {@code 'yes'}, {@code 'no'}, or {@code null}
+ */
+ public static String toStringYesNo(final Boolean bool) {
+ return toString(bool, "yes", "no", null);
+ }
+
+ /**
+ * <p>Converts a Boolean to a String returning one of the input Strings.</p>
+ *
+ * <pre>
+ * BooleanUtils.toString(Boolean.TRUE, "true", "false", null) = "true"
+ * BooleanUtils.toString(Boolean.FALSE, "true", "false", null) = "false"
+ * BooleanUtils.toString(null, "true", "false", null) = null;
+ * </pre>
+ *
+ * @param bool the Boolean to check
+ * @param trueString the String to return if {@code true}, may be {@code null}
+ * @param falseString the String to return if {@code false}, may be {@code null}
+ * @param nullString the String to return if {@code null}, may be {@code null}
+ * @return one of the three input Strings
+ */
+ public static String toString(final Boolean bool, final String trueString, final String falseString, final String nullString) {
+ if (bool == null) {
+ return nullString;
+ }
+ return bool.booleanValue() ? trueString : falseString;
+ }
+
+ // boolean to String methods
+ //-----------------------------------------------------------------------
+ /**
+ * <p>Converts a boolean to a String returning {@code 'true'}
+ * or {@code 'false'}.</p>
+ *
+ * <pre>
+ * BooleanUtils.toStringTrueFalse(true) = "true"
+ * BooleanUtils.toStringTrueFalse(false) = "false"
+ * </pre>
+ *
+ * @param bool the Boolean to check
+ * @return {@code 'true'}, {@code 'false'}, or {@code null}
+ */
+ public static String toStringTrueFalse(final boolean bool) {
+ return toString(bool, "true", "false");
+ }
+
+ /**
+ * <p>Converts a boolean to a String returning {@code 'on'}
+ * or {@code 'off'}.</p>
+ *
+ * <pre>
+ * BooleanUtils.toStringOnOff(true) = "on"
+ * BooleanUtils.toStringOnOff(false) = "off"
+ * </pre>
+ *
+ * @param bool the Boolean to check
+ * @return {@code 'on'}, {@code 'off'}, or {@code null}
+ */
+ public static String toStringOnOff(final boolean bool) {
+ return toString(bool, "on", "off");
+ }
+
+ /**
+ * <p>Converts a boolean to a String returning {@code 'yes'}
+ * or {@code 'no'}.</p>
+ *
+ * <pre>
+ * BooleanUtils.toStringYesNo(true) = "yes"
+ * BooleanUtils.toStringYesNo(false) = "no"
+ * </pre>
+ *
+ * @param bool the Boolean to check
+ * @return {@code 'yes'}, {@code 'no'}, or {@code null}
+ */
+ public static String toStringYesNo(final boolean bool) {
+ return toString(bool, "yes", "no");
+ }
+
+ /**
+ * <p>Converts a boolean to a String returning one of the input Strings.</p>
+ *
+ * <pre>
+ * BooleanUtils.toString(true, "true", "false") = "true"
+ * BooleanUtils.toString(false, "true", "false") = "false"
+ * </pre>
+ *
+ * @param bool the Boolean to check
+ * @param trueString the String to return if {@code true}, may be {@code null}
+ * @param falseString the String to return if {@code false}, may be {@code null}
+ * @return one of the two input Strings
+ */
+ public static String toString(final boolean bool, final String trueString, final String falseString) {
+ return bool ? trueString : falseString;
+ }
+
+ // logical operations
+ // ----------------------------------------------------------------------
+ /**
+ * <p>Performs an and on a set of booleans.</p>
+ *
+ * <pre>
+ * BooleanUtils.and(true, true) = true
+ * BooleanUtils.and(false, false) = false
+ * BooleanUtils.and(true, false) = false
+ * BooleanUtils.and(true, true, false) = false
+ * BooleanUtils.and(true, true, true) = true
+ * </pre>
+ *
+ * @param array an array of {@code boolean}s
+ * @return {@code true} if the and is successful.
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty.
+ * @since 3.0.1
+ */
+ public static boolean and(final boolean... array) {
+ // Validates input
+ if (array == null) {
+ throw new IllegalArgumentException("The Array must not be null");
+ }
+ if (array.length == 0) {
+ throw new IllegalArgumentException("Array is empty");
+ }
+ for (final boolean element : array) {
+ if (!element) {
+ return false;
+ }
+ }
+ return true;
+ }
+
+ /**
+ * <p>Performs an and on an array of Booleans.</p>
+ *
+ * <pre>
+ * BooleanUtils.and(Boolean.TRUE, Boolean.TRUE) = Boolean.TRUE
+ * BooleanUtils.and(Boolean.FALSE, Boolean.FALSE) = Boolean.FALSE
+ * BooleanUtils.and(Boolean.TRUE, Boolean.FALSE) = Boolean.FALSE
+ * BooleanUtils.and(Boolean.TRUE, Boolean.TRUE, Boolean.TRUE) = Boolean.TRUE
+ * BooleanUtils.and(Boolean.FALSE, Boolean.FALSE, Boolean.TRUE) = Boolean.FALSE
+ * BooleanUtils.and(Boolean.TRUE, Boolean.FALSE, Boolean.TRUE) = Boolean.FALSE
+ * </pre>
+ *
+ * @param array an array of {@code Boolean}s
+ * @return {@code true} if the and is successful.
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty.
+ * @throws IllegalArgumentException if {@code array} contains a {@code null}
+ * @since 3.0.1
+ */
+ public static Boolean and(final Boolean... array) {
+ if (array == null) {
+ throw new IllegalArgumentException("The Array must not be null");
+ }
+ if (array.length == 0) {
+ throw new IllegalArgumentException("Array is empty");
+ }
+ try {
+ final boolean[] primitive = ArrayUtils.toPrimitive(array);
+ return and(primitive) ? Boolean.TRUE : Boolean.FALSE;
+ } catch (final NullPointerException ex) {
+ throw new IllegalArgumentException("The array must not contain any null elements");
+ }
+ }
+
+ /**
+ * <p>Performs an or on a set of booleans.</p>
+ *
+ * <pre>
+ * BooleanUtils.or(true, true) = true
+ * BooleanUtils.or(false, false) = false
+ * BooleanUtils.or(true, false) = true
+ * BooleanUtils.or(true, true, false) = true
+ * BooleanUtils.or(true, true, true) = true
+ * BooleanUtils.or(false, false, false) = false
+ * </pre>
+ *
+ * @param array an array of {@code boolean}s
+ * @return {@code true} if the or is successful.
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty.
+ * @since 3.0.1
+ */
+ public static boolean or(final boolean... array) {
+ // Validates input
+ if (array == null) {
+ throw new IllegalArgumentException("The Array must not be null");
+ }
+ if (array.length == 0) {
+ throw new IllegalArgumentException("Array is empty");
+ }
+ for (final boolean element : array) {
+ if (element) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * <p>Performs an or on an array of Booleans.</p>
+ *
+ * <pre>
+ * BooleanUtils.or(Boolean.TRUE, Boolean.TRUE) = Boolean.TRUE
+ * BooleanUtils.or(Boolean.FALSE, Boolean.FALSE) = Boolean.FALSE
+ * BooleanUtils.or(Boolean.TRUE, Boolean.FALSE) = Boolean.TRUE
+ * BooleanUtils.or(Boolean.TRUE, Boolean.TRUE, Boolean.TRUE) = Boolean.TRUE
+ * BooleanUtils.or(Boolean.FALSE, Boolean.FALSE, Boolean.TRUE) = Boolean.TRUE
+ * BooleanUtils.or(Boolean.TRUE, Boolean.FALSE, Boolean.TRUE) = Boolean.TRUE
+ * BooleanUtils.or(Boolean.FALSE, Boolean.FALSE, Boolean.FALSE) = Boolean.FALSE
+ * </pre>
+ *
+ * @param array an array of {@code Boolean}s
+ * @return {@code true} if the or is successful.
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty.
+ * @throws IllegalArgumentException if {@code array} contains a {@code null}
+ * @since 3.0.1
+ */
+ public static Boolean or(final Boolean... array) {
+ if (array == null) {
+ throw new IllegalArgumentException("The Array must not be null");
+ }
+ if (array.length == 0) {
+ throw new IllegalArgumentException("Array is empty");
+ }
+ try {
+ final boolean[] primitive = ArrayUtils.toPrimitive(array);
+ return or(primitive) ? Boolean.TRUE : Boolean.FALSE;
+ } catch (final NullPointerException ex) {
+ throw new IllegalArgumentException("The array must not contain any null elements");
+ }
+ }
+
+ /**
+ * <p>Performs an xor on a set of booleans.</p>
+ *
+ * <pre>
+ * BooleanUtils.xor(true, true) = false
+ * BooleanUtils.xor(false, false) = false
+ * BooleanUtils.xor(true, false) = true
+ * BooleanUtils.xor(true, true) = false
+ * BooleanUtils.xor(false, false) = false
+ * BooleanUtils.xor(true, false) = true
+ * </pre>
+ *
+ * @param array an array of {@code boolean}s
+ * @return {@code true} if the xor is successful.
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty.
+ */
+ public static boolean xor(final boolean... array) {
+ // Validates input
+ if (array == null) {
+ throw new IllegalArgumentException("The Array must not be null");
+ }
+ if (array.length == 0) {
+ throw new IllegalArgumentException("Array is empty");
+ }
+
+ // false if the neutral element of the xor operator
+ boolean result = false;
+ for (final boolean element : array) {
+ result ^= element;
+ }
+
+ return result;
+ }
+
+ /**
+ * <p>Performs an xor on an array of Booleans.</p>
+ *
+ * <pre>
+ * BooleanUtils.xor(new Boolean[] { Boolean.TRUE, Boolean.TRUE }) = Boolean.FALSE
+ * BooleanUtils.xor(new Boolean[] { Boolean.FALSE, Boolean.FALSE }) = Boolean.FALSE
+ * BooleanUtils.xor(new Boolean[] { Boolean.TRUE, Boolean.FALSE }) = Boolean.TRUE
+ * </pre>
+ *
+ * @param array an array of {@code Boolean}s
+ * @return {@code true} if the xor is successful.
+ * @throws IllegalArgumentException if {@code array} is {@code null}
+ * @throws IllegalArgumentException if {@code array} is empty.
+ * @throws IllegalArgumentException if {@code array} contains a {@code null}
+ */
+ public static Boolean xor(final Boolean... array) {
+ if (array == null) {
+ throw new IllegalArgumentException("The Array must not be null");
+ }
+ if (array.length == 0) {
+ throw new IllegalArgumentException("Array is empty");
+ }
+ try {
+ final boolean[] primitive = ArrayUtils.toPrimitive(array);
+ return xor(primitive) ? Boolean.TRUE : Boolean.FALSE;
+ } catch (final NullPointerException ex) {
+ throw new IllegalArgumentException("The array must not contain any null elements");
+ }
+ }
+
+ /**
+ * <p>Compares two {@code boolean} values. This is the same functionality as provided in Java 7.</p>
+ *
+ * @param x the first {@code boolean} to compare
+ * @param y the second {@code boolean} to compare
+ * @return the value {@code 0} if {@code x == y};
+ * a value less than {@code 0} if {@code !x && y}; and
+ * a value greater than {@code 0} if {@code x && !y}
+ * @since 3.4
+ */
+ public static int compare(boolean x, boolean y) {
+ if (x == y) {
+ return 0;
+ }
+ if (x) {
+ return 1;
+ } else {
+ return -1;
+ }
+ }
+
+}
[3/3] [lang] Simplify, less clutter.
Posted by gg...@apache.org.
Simplify, less clutter.
Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/69d4bf88
Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/69d4bf88
Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/69d4bf88
Branch: refs/heads/master
Commit: 69d4bf883cd7402d13497a40422d20096b2b9aa9
Parents: bb76a68
Author: ggregory <gg...@apache.org>
Authored: Sat Jan 16 14:37:38 2016 -0800
Committer: ggregory <gg...@apache.org>
Committed: Sat Jan 16 14:37:38 2016 -0800
----------------------------------------------------------------------
src/main/java/org/apache/commons/lang3/BooleanUtils.java | 6 +-----
1 file changed, 1 insertion(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-lang/blob/69d4bf88/src/main/java/org/apache/commons/lang3/BooleanUtils.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/lang3/BooleanUtils.java b/src/main/java/org/apache/commons/lang3/BooleanUtils.java
index ba5dea0..2c46d5b 100644
--- a/src/main/java/org/apache/commons/lang3/BooleanUtils.java
+++ b/src/main/java/org/apache/commons/lang3/BooleanUtils.java
@@ -1098,11 +1098,7 @@ public class BooleanUtils {
if (x == y) {
return 0;
}
- if (x) {
- return 1;
- } else {
- return -1;
- }
+ return x ? 1 : -1;
}
}