Apache/commons-lang
1
0
Fork 0
mirror of https://github.com/apache/commons-lang.git synced 2025-02-12 13:05:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document (wrong?) behavior of xor methods

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@1532031 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Benedikt Ritter 2013-10-14 19:21:02 +00:00
parent 469d0dd52a
commit 01fce8e321
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/main/java/org/apache/commons/lang3/BooleanUtils.java
View File

@ -1028,6 +1028,14 @@ public static Boolean or(final Boolean... array) {
* BooleanUtils.xor(true, false) = true
* </pre>
*
* <p>Note that this method behaves different from using the binary XOR operator (^). Instead of combining the given
* booleans using the XOR operator from left to right, this method counts the appearances of true in the given
* array. It will only return true if exactly one boolean in the given array is true:</p>
* <pre>
* true ^ true ^ false ^ true = true
* BooleanUtils.xor(true, true, false, true) = false
* </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}
@ -1069,6 +1077,9 @@ public static boolean xor(final boolean... array) {
* BooleanUtils.xor(new Boolean[] { Boolean.TRUE, Boolean.FALSE }) = Boolean.TRUE
* </pre>
*
* <p>Note that this method behaves different from using the binary XOR operator (^). See
* {@link #xor(boolean...)}.</p>
*
* @param array an array of {@code Boolean}s
* @return {@code true} if the xor is successful.
* @throws IllegalArgumentException if {@code array} is {@code null}