Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LANG-1278: BooleanUtils javadoc issues

This commit is contained in:
pascalschumacher 2016-10-21 21:07:10 +02:00
parent 6423a76655
commit 91d6bd74fa
2 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/changes/changes.xml
View File

@ -46,6 +46,7 @@ The <action> type attribute can be add,update,fix,remove.
<body>
<release version="3.6" date="tba" description="tba">
<action issue="LANG-1278" type="fix" dev="pschumacher" due-to="Duke Yin">BooleanUtils javadoc issues</action>
<action issue="LANG-1277" type="update" dev="pschumacher" due-to="yufcuy">StringUtils#getLevenshteinDistance reduce memory consumption</action>
<action issue="LANG-1070" type="fix" dev="pschumacher" due-to="Paul Pogonyshev">ArrayUtils#add confusing example in javadoc</action>
<action issue="LANG-1271" type="fix" dev="pschumacher" due-to="Pierre Templier">StringUtils#isAnyEmpty and #isAnyBlank should return false for an empty array</action>

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

@ -48,7 +48,7 @@ public class BooleanUtils {
*
* <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>
* <p>NOTE: This returns null and will throw a NullPointerException if unboxed to a boolean. </p>
*
* <pre>
* BooleanUtils.negate(Boolean.TRUE) = Boolean.FALSE;
@ -222,7 +222,7 @@ public class BooleanUtils {
*
* <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>
* <p>NOTE: This returns null and will throw a NullPointerException if unboxed to a boolean. </p>
*
* <pre>
* BooleanUtils.toBoolean(Integer.valueOf(0)) = Boolean.FALSE
@ -305,7 +305,7 @@ public class BooleanUtils {
/**
* <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>
* <p>NOTE: This returns null and will throw a NullPointerException if unboxed to a boolean. </p>
*
* <pre>
* BooleanUtils.toBooleanObject(0, 0, 2, 3) = Boolean.TRUE
@ -337,7 +337,7 @@ public class BooleanUtils {
/**
* <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>
* <p>NOTE: This returns null and will throw a NullPointerException if unboxed to a boolean. </p>
*
* <pre>
* BooleanUtils.toBooleanObject(Integer.valueOf(0), Integer.valueOf(0), Integer.valueOf(2), Integer.valueOf(3)) = Boolean.TRUE
@ -518,7 +518,7 @@ public class BooleanUtils {
* (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>
* <p>NOTE: This returns null and will throw a NullPointerException if unboxed to a boolean. </p>
*
* <pre>
* // N.B. case is not significant
@ -636,7 +636,7 @@ public class BooleanUtils {
/**
* <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>
* <p>NOTE: This returns null and will throw a NullPointerException if unboxed to a boolean. </p>
*
* <pre>
* BooleanUtils.toBooleanObject("true", "true", "false", "null") = Boolean.TRUE
@ -1026,9 +1026,6 @@ public class BooleanUtils {
* 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