Author: bayard Date: Tue Aug 23 07:36:08 2011 New Revision: 1160571 URL: http://svn.apache.org/viewvc?rev=1160571&view=rev Log: Adding documentation that the Mutable numbers don't work as might be expected with String.format. LANG-698
Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java?rev=1160571&r1=1160570&r2=1160571&view=diff ============================================================================== --- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java (original) +++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableBoolean.java Tue Aug 23 07:36:08 2011 @@ -21,6 +21,8 @@ import java.io.Serializable; /** * A mutable <code>boolean</code> wrapper. + * <p> + * Note that as MutableBoolean does not extend Boolean, it is not treated by String.format as a Boolean parameter. * * @see Boolean * @since 2.2 Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java?rev=1160571&r1=1160570&r2=1160571&view=diff ============================================================================== --- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java (original) +++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableByte.java Tue Aug 23 07:36:08 2011 @@ -18,6 +18,8 @@ package org.apache.commons.lang3.mutable /** * A mutable <code>byte</code> wrapper. + * <p> + * Note that as MutableByte does not extend Byte, it is not treated by String.format as a Byte parameter. * * @see Byte * @since 2.1 Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java?rev=1160571&r1=1160570&r2=1160571&view=diff ============================================================================== --- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java (original) +++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableDouble.java Tue Aug 23 07:36:08 2011 @@ -18,6 +18,8 @@ package org.apache.commons.lang3.mutable /** * A mutable <code>double</code> wrapper. + * <p> + * Note that as MutableDouble does not extend Double, it is not treated by String.format as a Double parameter. * * @see Double * @since 2.1 Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java?rev=1160571&r1=1160570&r2=1160571&view=diff ============================================================================== --- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java (original) +++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableFloat.java Tue Aug 23 07:36:08 2011 @@ -18,6 +18,8 @@ package org.apache.commons.lang3.mutable /** * A mutable <code>float</code> wrapper. + * <p> + * Note that as MutableFloat does not extend Float, it is not treated by String.format as a Float parameter. * * @see Float * @since 2.1 Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java?rev=1160571&r1=1160570&r2=1160571&view=diff ============================================================================== --- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java (original) +++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableInt.java Tue Aug 23 07:36:08 2011 @@ -18,6 +18,8 @@ package org.apache.commons.lang3.mutable /** * A mutable <code>int</code> wrapper. + * <p> + * Note that as MutableInt does not extend Integer, it is not treated by String.format as an Integer parameter. * * @see Integer * @since 2.1 Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java?rev=1160571&r1=1160570&r2=1160571&view=diff ============================================================================== --- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java (original) +++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableLong.java Tue Aug 23 07:36:08 2011 @@ -18,6 +18,8 @@ package org.apache.commons.lang3.mutable /** * A mutable <code>long</code> wrapper. + * <p> + * Note that as MutableLong does not extend Long, it is not treated by String.format as a Long parameter. * * @see Long * @since 2.1 Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java?rev=1160571&r1=1160570&r2=1160571&view=diff ============================================================================== --- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java (original) +++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/mutable/MutableShort.java Tue Aug 23 07:36:08 2011 @@ -18,6 +18,8 @@ package org.apache.commons.lang3.mutable /** * A mutable <code>short</code> wrapper. + * <p> + * Note that as MutableShort does not extend Short, it is not treated by String.format as a Short parameter. * * @see Short * @since 2.1