Java Doc for BooleanUtils.java in  » Library » Apache-common-lang » org » apache » commons » lang » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Operations on boolean primitives and Boolean objects.

This class tries to handle null input gracefully. An exception will not be thrown for a null input. Each method documents its behaviour in more detail.

BooleanUtils instances should NOT be constructed in standard programming.

Converts a String to a boolean (optimised for performance).

'true', 'on' or 'yes' (case insensitive) will return true.

Converts a String to a Boolean.

'true', 'on' or 'yes' (case insensitive) will return true.

BooleanUtils instances should NOT be constructed in standard programming. Instead, the class should be used as BooleanUtils.toBooleanObject(true);.

This constructor is public to permit tools that require a JavaBean instance to operate.

Checks if a Boolean value is false, handling null by returning false.

 BooleanUtils.isFalse(Boolean.TRUE)  = false
 BooleanUtils.isFalse(Boolean.FALSE) = true
 BooleanUtils.isFalse(null)          = false
 

Checks if a Boolean value is not false, handling null by returning true.

 BooleanUtils.isNotFalse(Boolean.TRUE)  = true
 BooleanUtils.isNotFalse(Boolean.FALSE) = false
 BooleanUtils.isNotFalse(null)          = true
 

Checks if a Boolean value is not true, handling null by returning true.

 BooleanUtils.isNotTrue(Boolean.TRUE)  = false
 BooleanUtils.isNotTrue(Boolean.FALSE) = true
 BooleanUtils.isNotTrue(null)          = true
 

Checks if a Boolean value is true, handling null by returning false.

 BooleanUtils.isTrue(Boolean.TRUE)  = true
 BooleanUtils.isTrue(Boolean.FALSE) = false
 BooleanUtils.isTrue(null)          = false
 

Negates the specified boolean.

If null is passed in, null will be returned.

 BooleanUtils.negate(Boolean.TRUE)  = Boolean.FALSE;
 BooleanUtils.negate(Boolean.FALSE) = Boolean.TRUE;
 BooleanUtils.negate(null)          = null;
 

Converts a Boolean to a boolean handling null by returning false.

 BooleanUtils.toBoolean(Boolean.TRUE)  = true
 BooleanUtils.toBoolean(Boolean.FALSE) = false
 BooleanUtils.toBoolean(null)          = false
 

Converts an int to a boolean using the convention that zero is false.

 BooleanUtils.toBoolean(0) = false
 BooleanUtils.toBoolean(1) = true
 BooleanUtils.toBoolean(2) = true
 

Converts an int to a boolean specifying the conversion values.

 BooleanUtils.toBoolean(0, 1, 0) = false
 BooleanUtils.toBoolean(1, 1, 0) = true
 BooleanUtils.toBoolean(2, 1, 2) = false
 BooleanUtils.toBoolean(2, 2, 0) = true
 

Converts an Integer to a boolean specifying the conversion values.

 BooleanUtils.toBoolean(new Integer(0), new Integer(1), new Integer(0)) = false
 BooleanUtils.toBoolean(new Integer(1), new Integer(1), new Integer(0)) = true
 BooleanUtils.toBoolean(new Integer(2), new Integer(1), new Integer(2)) = false
 BooleanUtils.toBoolean(new Integer(2), new Integer(2), new Integer(0)) = true
 BooleanUtils.toBoolean(null, null, new Integer(0))                     = true
 

Converts a String to a boolean (optimised for performance).

'true', 'on' or 'yes' (case insensitive) will return true. Otherwise, false is returned.

This method performs 4 times faster (JDK1.4) than Boolean.valueOf(String). However, this method accepts 'on' and 'yes' as true values.

 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
 

Converts a String to a Boolean throwing an exception if no match found.

null is returned if there is no match.

 BooleanUtils.toBoolean("true", "true", "false")  = true
 BooleanUtils.toBoolean("false", "true", "false") = false
 

Converts a Boolean to a boolean handling null.

 BooleanUtils.toBooleanDefaultIfNull(Boolean.TRUE, false) = true
 BooleanUtils.toBooleanDefaultIfNull(Boolean.FALSE, true) = false
 BooleanUtils.toBooleanDefaultIfNull(null, true)          = true
 

Boolean factory that avoids creating new Boolean objecs all the time.

This method was added to JDK1.4 but is available here for earlier JDKs.

 BooleanUtils.toBooleanObject(false) = Boolean.FALSE
 BooleanUtils.toBooleanObject(true)  = Boolean.TRUE
 

Converts an int to a Boolean using the convention that zero is false.

 BooleanUtils.toBoolean(0) = Boolean.FALSE
 BooleanUtils.toBoolean(1) = Boolean.TRUE
 BooleanUtils.toBoolean(2) = Boolean.TRUE
 

Converts an Integer to a Boolean using the convention that zero is false.

null will be converted to null.

 BooleanUtils.toBoolean(new Integer(0))    = Boolean.FALSE
 BooleanUtils.toBoolean(new Integer(1))    = Boolean.TRUE
 BooleanUtils.toBoolean(new Integer(null)) = null
 

Converts an int to a Boolean specifying the conversion values.

 BooleanUtils.toBooleanObject(0, 0, 2, 3) = Boolean.TRUE
 BooleanUtils.toBooleanObject(2, 1, 2, 3) = Boolean.FALSE
 BooleanUtils.toBooleanObject(3, 1, 2, 3) = null
 

Converts an Integer to a Boolean specifying the conversion values.

 BooleanUtils.toBooleanObject(new Integer(0), new Integer(0), new Integer(2), new Integer(3)) = Boolean.TRUE
 BooleanUtils.toBooleanObject(new Integer(2), new Integer(1), new Integer(2), new Integer(3)) = Boolean.FALSE
 BooleanUtils.toBooleanObject(new Integer(3), new Integer(1), new Integer(2), new Integer(3)) = null
 

Converts a String to a Boolean.

'true', 'on' or 'yes' (case insensitive) will return true. 'false', 'off' or 'no' (case insensitive) will return false. Otherwise, null is returned.

 BooleanUtils.toBooleanObject(null)    = null
 BooleanUtils.toBooleanObject("true")  = Boolean.TRUE
 BooleanUtils.toBooleanObject("false") = Boolean.FALSE
 BooleanUtils.toBooleanObject("on")    = Boolean.TRUE
 BooleanUtils.toBooleanObject("ON")    = Boolean.TRUE
 BooleanUtils.toBooleanObject("off")   = Boolean.FALSE
 BooleanUtils.toBooleanObject("oFf")   = Boolean.FALSE
 BooleanUtils.toBooleanObject("blue")  = null
 

Converts a String to a Boolean throwing an exception if no match.

 BooleanUtils.toBooleanObject("true", "true", "false", "null")  = Boolean.TRUE
 BooleanUtils.toBooleanObject("false", "true", "false", "null") = Boolean.FALSE
 BooleanUtils.toBooleanObject("null", "true", "false", "null")  = null
 

Converts a boolean to an int using the convention that zero is false.

 BooleanUtils.toInteger(true)  = 1
 BooleanUtils.toInteger(false) = 0
 

Converts a boolean to an int specifying the conversion values.

 BooleanUtils.toInteger(true, 1, 0)  = 1
 BooleanUtils.toInteger(false, 1, 0) = 0
 

Converts a Boolean to an int specifying the conversion values.

 BooleanUtils.toInteger(Boolean.TRUE, 1, 0, 2)  = 1
 BooleanUtils.toInteger(Boolean.FALSE, 1, 0, 2) = 0
 BooleanUtils.toInteger(null, 1, 0, 2)          = 2
 

Converts a boolean to an Integer using the convention that zero is false.

 BooleanUtils.toIntegerObject(true)  = new Integer(1)
 BooleanUtils.toIntegerObject(false) = new Integer(0)
 

Converts a Boolean to a Integer using the convention that zero is false.

null will be converted to null.

 BooleanUtils.toIntegerObject(Boolean.TRUE)  = new Integer(1)
 BooleanUtils.toIntegerObject(Boolean.FALSE) = new Integer(0)
 

Converts a boolean to an Integer specifying the conversion values.

 BooleanUtils.toIntegerObject(true, new Integer(1), new Integer(0))  = new Integer(1)
 BooleanUtils.toIntegerObject(false, new Integer(1), new Integer(0)) = new Integer(0)
 

Converts a Boolean to an Integer specifying the conversion values.

 BooleanUtils.toIntegerObject(Boolean.TRUE, new Integer(1), new Integer(0), new Integer(2))  = new Integer(1)
 BooleanUtils.toIntegerObject(Boolean.FALSE, new Integer(1), new Integer(0), new Integer(2)) = new Integer(0)
 BooleanUtils.toIntegerObject(null, new Integer(1), new Integer(0), new Integer(2))          = new Integer(2)
 

Converts a Boolean to a String returning one of the input Strings.

 BooleanUtils.toString(Boolean.TRUE, "true", "false", null)   = "true"
 BooleanUtils.toString(Boolean.FALSE, "true", "false", null)  = "false"
 BooleanUtils.toString(null, "true", "false", null)           = null;
 

Converts a boolean to a String returning one of the input Strings.

 BooleanUtils.toString(true, "true", "false")   = "true"
 BooleanUtils.toString(false, "true", "false")  = "false"
 

Converts a Boolean to a String returning 'on', 'off', or null.

 BooleanUtils.toStringOnOff(Boolean.TRUE)  = "on"
 BooleanUtils.toStringOnOff(Boolean.FALSE) = "off"
 BooleanUtils.toStringOnOff(null)          = null;
 

Converts a boolean to a String returning 'on' or 'off'.

 BooleanUtils.toStringOnOff(true)   = "on"
 BooleanUtils.toStringOnOff(false)  = "off"
 

Converts a Boolean to a String returning 'true', 'false', or null.

 BooleanUtils.toStringTrueFalse(Boolean.TRUE)  = "true"
 BooleanUtils.toStringTrueFalse(Boolean.FALSE) = "false"
 BooleanUtils.toStringTrueFalse(null)          = null;
 

Converts a boolean to a String returning 'true' or 'false'.

 BooleanUtils.toStringTrueFalse(true)   = "true"
 BooleanUtils.toStringTrueFalse(false)  = "false"
 

Converts a Boolean to a String returning 'yes', 'no', or null.

 BooleanUtils.toStringYesNo(Boolean.TRUE)  = "yes"
 BooleanUtils.toStringYesNo(Boolean.FALSE) = "no"
 BooleanUtils.toStringYesNo(null)          = null;
 

Converts a boolean to a String returning 'yes' or 'no'.

 BooleanUtils.toStringYesNo(true)   = "yes"
 BooleanUtils.toStringYesNo(false)  = "no"
 

Performs an xor on a set of booleans.

 BooleanUtils.xor(new boolean[] { true, true })   = false
 BooleanUtils.xor(new boolean[] { false, false }) = false
 BooleanUtils.xor(new boolean[] { true, false })  = true
 

Performs an xor on an array of Booleans.

 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