Author: sebb
Date: Sun Nov 11 13:00:08 2012
New Revision: 1407967
URL: http://svn.apache.org/viewvc?rev=1407967&view=rev
Log:
Document return value with null input
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/math/NumberUtils.java
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/math/NumberUtils.java
URL:
http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/math/NumberUtils.java?rev=1407967&r1=1407966&r2=1407967&view=diff
==============================================================================
---
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/math/NumberUtils.java
(original)
+++
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/math/NumberUtils.java
Sun Nov 11 13:00:08 2012
@@ -628,7 +628,7 @@ public class NumberUtils {
* <p>Returns <code>null</code> if the string is <code>null</code>.</p>
*
* @param str a <code>String</code> to convert, may be null
- * @return converted <code>Float</code>
+ * @return converted <code>Float</code> (or null if the input is null)
* @throws NumberFormatException if the value cannot be converted
*/
public static Float createFloat(String str) {
@@ -644,7 +644,7 @@ public class NumberUtils {
* <p>Returns <code>null</code> if the string is <code>null</code>.</p>
*
* @param str a <code>String</code> to convert, may be null
- * @return converted <code>Double</code>
+ * @return converted <code>Double</code> (or null if the input is null)
* @throws NumberFormatException if the value cannot be converted
*/
public static Double createDouble(String str) {
@@ -661,7 +661,7 @@ public class NumberUtils {
* <p>Returns <code>null</code> if the string is <code>null</code>.</p>
*
* @param str a <code>String</code> to convert, may be null
- * @return converted <code>Integer</code>
+ * @return converted <code>Integer</code> (or null if the input is null)
* @throws NumberFormatException if the value cannot be converted
*/
public static Integer createInteger(String str) {
@@ -679,7 +679,7 @@ public class NumberUtils {
* <p>Returns <code>null</code> if the string is <code>null</code>.</p>
*
* @param str a <code>String</code> to convert, may be null
- * @return converted <code>Long</code>
+ * @return converted <code>Long</code> (or null if the input is null)
* @throws NumberFormatException if the value cannot be converted
*/
public static Long createLong(String str) {
@@ -695,7 +695,7 @@ public class NumberUtils {
* <p>Returns <code>null</code> if the string is <code>null</code>.</p>
*
* @param str a <code>String</code> to convert, may be null
- * @return converted <code>BigInteger</code>
+ * @return converted <code>BigInteger</code> (or null if the input is null)
* @throws NumberFormatException if the value cannot be converted
*/
public static BigInteger createBigInteger(String str) {
@@ -711,7 +711,7 @@ public class NumberUtils {
* <p>Returns <code>null</code> if the string is <code>null</code>.</p>
*
* @param str a <code>String</code> to convert, may be null
- * @return converted <code>BigDecimal</code>
+ * @return converted <code>BigDecimal</code> (or null if the input is null)
* @throws NumberFormatException if the value cannot be converted
*/
public static BigDecimal createBigDecimal(String str) {
