Boolean Utils

Author: Deepak Malik

README.md

@@ -154,7 +154,7 @@ Below topics/problems are covered as of now.
 - [ ] NumberUtils
 - [X] [ArrayUtils](../master/src/com/deepak/data/structures/Utils/ArrayUtils.java)
 - [ ] ListUtils
-- [ ] BooleanUtils
+- [X] [BooleanUtils](../master/src/com/deepak/data/structures/Utils/BooleanUtils.java)
 - [ ] CollectionUtils
 - [ ] MapUtils
 - [ ] DateUtils

src/com/deepak/data/structures/Utils/BooleanUtils.java

@@ -0,0 +1,94 @@
+/**
+ * Data-Structures-In-Java
+ * BooleanUtils.java
+ */
+package com.deepak.data.structures.Utils;
+
+/**
+ * Utilities for Boolean
+ * 
+ * @author Deepak
+ */
+public class BooleanUtils {
+
+	/**
+	 * Method to negate a Boolean
+	 * 
+	 * @param bool
+	 * @return {@link Boolean}
+	 */
+	public static Boolean negate(final Boolean bool) {
+		if (bool == null) {
+			return null;
+		}
+		return bool.booleanValue() ? Boolean.FALSE : Boolean.TRUE;
+	}
+
+	/**
+	 * Method to check if boolean is True
+	 * 
+	 * @param bool
+	 * @return {@link boolean}
+	 */
+	public static boolean isTrue(final boolean bool) {
+		return Boolean.TRUE.equals(bool);
+	}
+
+	/**
+	 * Method to check if boolean is false
+	 * 
+	 * @param bool
+	 * @return {@link boolean}
+	 */
+	public static boolean isFalse(final boolean bool) {
+		return Boolean.FALSE.equals(bool);
+	}
+
+	/**
+	 * Method to convert Boolean object to boolean primitive
+	 * 
+	 * @param bool
+	 * @return {@link boolean}
+	 */
+	public static boolean toBoolean(final Boolean bool) {
+		return bool != null && bool.booleanValue();
+	}
+
+	/**
+	 * Method to convert int to boolean
+	 * 
+	 * @param val
+	 * @return {@link boolean}
+	 */
+	public static boolean toBoolean(final int val) {
+		return val != 0;
+	}
+
+	/**
+	 * Method to convert int to Boolean object
+	 * 
+	 * @param val
+	 * @return {@link Boolean}
+	 */
+	public static Boolean toBooleanObject(final int val) {
+		return val != 0 ? Boolean.TRUE : Boolean.FALSE;
+	}
+
+	/**
+	 * Method to compare two boolean values
+	 * If both the same, it returns 0, if x is true, it returns 1
+	 * else it returns -1
+	 * 
+	 * @param x
+	 * @param y
+	 * @return {@link int}
+	 */
+	public static int compare(final boolean x, final boolean y) {
+		if (x == y) {
+			return 0;
+		}
+		return x ? 1 : -1;
+	}
+
+}
+

test/com/deepak/data/structures/Utils/BooleanUtilsTest.java

@@ -0,0 +1,74 @@
+/**
+ * Data-Structures-In-Java
+ * BooleanUtilsTest.java
+ */
+package com.deepak.data.structures.Utils;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+/**
+ * Test cases for Boolean Utility functions
+ * 
+ * @author Deepak
+ */
+public class BooleanUtilsTest {
+
+	/**
+	 * Test case to check negation
+	 */
+	@Test
+	public void testNegateBoolean() {
+		Assert.assertEquals(BooleanUtils.negate(Boolean.TRUE), Boolean.FALSE);
+		Assert.assertEquals(BooleanUtils.negate(Boolean.FALSE), Boolean.TRUE);
+		Assert.assertEquals(BooleanUtils.negate(null), null);
+	}
+
+	/**
+	 * Test case to check is True
+	 */
+	@Test
+	public void testIsTrue() {
+		Assert.assertEquals(BooleanUtils.isTrue(Boolean.TRUE), true);
+		Assert.assertEquals(BooleanUtils.isTrue(Boolean.FALSE), false);
+	}
+
+	/**
+	 * Test case to check is False
+	 */
+	@Test
+	public void testIsFalse() {
+		Assert.assertEquals(BooleanUtils.isFalse(Boolean.TRUE), false);
+		Assert.assertEquals(BooleanUtils.isFalse(Boolean.FALSE), true);
+	}
+
+	/**
+	 * Test case to convert Boolean object to primitive boolean
+	 */
+	@Test
+	public void testToBoolean() {
+		Assert.assertEquals(BooleanUtils.toBoolean(Boolean.TRUE), true);
+		Assert.assertEquals(BooleanUtils.toBoolean(Boolean.FALSE), false);
+	}
+
+	/**
+	 * Test case to convert int to Boolean object
+	 */
+	@Test
+	public void testToBooleanObject() {
+		Assert.assertEquals(BooleanUtils.toBooleanObject(0), Boolean.FALSE);
+		Assert.assertEquals(BooleanUtils.toBooleanObject(1), Boolean.TRUE);
+		Assert.assertEquals(BooleanUtils.toBooleanObject(2), Boolean.TRUE);
+	}
+
+	/**
+	 * Test case to compare two boolean
+	 */
+	@Test
+	public void testCompare() {
+		Assert.assertEquals(BooleanUtils.compare(true, true), 0);
+		Assert.assertEquals(BooleanUtils.compare(true, false), 1);
+		Assert.assertEquals(BooleanUtils.compare(false, true), -1);
+	}
+
+}