Author: bayard Date: Thu Feb 3 19:07:18 2005 New Revision: 151304 URL: http://svn.apache.org/viewcvs?view=rev&rev=151304 Log: added javadoc to primitiveValue methods
Modified: jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableByte.java jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableDouble.java jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableFloat.java jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableInt.java jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableLong.java jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableShort.java Modified: jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableByte.java URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableByte.java?view=diff&r1=151303&r2=151304 ============================================================================== --- jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableByte.java (original) +++ jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableByte.java Thu Feb 3 19:07:18 2005 @@ -21,7 +21,7 @@ * * @see Byte * @since 2.1 - * @version $Id: MutableByte.java,v 1.6 2004/10/08 19:45:46 ggregory Exp $ + * @version $Id$ */ public class MutableByte extends Number implements Comparable, Mutable { @@ -97,22 +97,48 @@ } //----------------------------------------------------------------------- + // shortValue relies on Number implementation + /** + * Returns the value of this MutableByte as a byte. + * + * @return the numeric value represented by this object after conversion to type byte. + */ public byte byteValue() { return value; } + /** + * Returns the value of this MutableByte as a int. + * + * @return the numeric value represented by this object after conversion to type int. + */ public int intValue() { return value; } + /** + * Returns the value of this MutableByte as a long. + * + * @return the numeric value represented by this object after conversion to type long. + */ public long longValue() { return value; } + /** + * Returns the value of this MutableByte as a float. + * + * @return the numeric value represented by this object after conversion to type float. + */ public float floatValue() { return value; } + /** + * Returns the value of this MutableByte as a double. + * + * @return the numeric value represented by this object after conversion to type double. + */ public double doubleValue() { return value; } Modified: jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableDouble.java URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableDouble.java?view=diff&r1=151303&r2=151304 ============================================================================== --- jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableDouble.java (original) +++ jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableDouble.java Thu Feb 3 19:07:18 2005 @@ -23,7 +23,7 @@ * * @see Double * @since 2.1 - * @version $Id: MutableDouble.java,v 1.5 2004/10/08 19:45:46 ggregory Exp $ + * @version $Id$ */ public class MutableDouble extends Number implements Comparable, Mutable { @@ -99,18 +99,39 @@ } //----------------------------------------------------------------------- + // shortValue and bytValue rely on Number implementation + /** + * Returns the value of this MutableDouble as a int. + * + * @return the numeric value represented by this object after conversion to type int. + */ public int intValue() { return (int) value; } + /** + * Returns the value of this MutableDouble as a long. + * + * @return the numeric value represented by this object after conversion to type long. + */ public long longValue() { return (long) value; } + /** + * Returns the value of this MutableDouble as a float. + * + * @return the numeric value represented by this object after conversion to type float. + */ public float floatValue() { return (float) value; } + /** + * Returns the value of this MutableDouble as a double. + * + * @return the numeric value represented by this object after conversion to type double. + */ public double doubleValue() { return value; } Modified: jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableFloat.java URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableFloat.java?view=diff&r1=151303&r2=151304 ============================================================================== --- jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableFloat.java (original) +++ jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableFloat.java Thu Feb 3 19:07:18 2005 @@ -23,7 +23,7 @@ * * @see Float * @since 2.1 - * @version $Id: MutableFloat.java,v 1.7 2004/10/08 21:33:03 scolebourne Exp $ + * @version $Id$ */ public class MutableFloat extends Number implements Comparable, Mutable { @@ -99,18 +99,39 @@ } //----------------------------------------------------------------------- + // shortValue and bytValue rely on Number implementation + /** + * Returns the value of this MutableFloat as a int. + * + * @return the numeric value represented by this object after conversion to type int. + */ public int intValue() { return (int) value; } + /** + * Returns the value of this MutableFloat as a long. + * + * @return the numeric value represented by this object after conversion to type long. + */ public long longValue() { return (long) value; } + /** + * Returns the value of this MutableFloat as a float. + * + * @return the numeric value represented by this object after conversion to type float. + */ public float floatValue() { return value; } + /** + * Returns the value of this MutableFloat as a double. + * + * @return the numeric value represented by this object after conversion to type double. + */ public double doubleValue() { return value; } Modified: jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableInt.java URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableInt.java?view=diff&r1=151303&r2=151304 ============================================================================== --- jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableInt.java (original) +++ jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableInt.java Thu Feb 3 19:07:18 2005 @@ -21,7 +21,7 @@ * * @see Integer * @since 2.1 - * @version $Id: MutableInt.java,v 1.4 2004/10/08 19:45:46 ggregory Exp $ + * @version $Id$ */ public class MutableInt extends Number implements Comparable, Mutable { @@ -97,18 +97,39 @@ } //----------------------------------------------------------------------- + // shortValue and bytValue rely on Number implementation + /** + * Returns the value of this MutableInt as a int. + * + * @return the numeric value represented by this object after conversion to type int. + */ public int intValue() { return value; } + /** + * Returns the value of this MutableInt as a long. + * + * @return the numeric value represented by this object after conversion to type long. + */ public long longValue() { return value; } + /** + * Returns the value of this MutableInt as a float. + * + * @return the numeric value represented by this object after conversion to type float. + */ public float floatValue() { return value; } + /** + * Returns the value of this MutableInt as a double. + * + * @return the numeric value represented by this object after conversion to type double. + */ public double doubleValue() { return value; } Modified: jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableLong.java URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableLong.java?view=diff&r1=151303&r2=151304 ============================================================================== --- jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableLong.java (original) +++ jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableLong.java Thu Feb 3 19:07:18 2005 @@ -21,7 +21,7 @@ * * @see Long * @since 2.1 - * @version $Id: MutableLong.java,v 1.6 2004/10/08 19:45:46 ggregory Exp $ + * @version $Id$ */ public class MutableLong extends Number implements Comparable, Mutable { @@ -97,18 +97,39 @@ } //----------------------------------------------------------------------- + // shortValue and bytValue rely on Number implementation + /** + * Returns the value of this MutableLong as a int. + * + * @return the numeric value represented by this object after conversion to type int. + */ public int intValue() { return (int) value; } + /** + * Returns the value of this MutableLong as a long. + * + * @return the numeric value represented by this object after conversion to type long. + */ public long longValue() { return value; } + /** + * Returns the value of this MutableLong as a float. + * + * @return the numeric value represented by this object after conversion to type float. + */ public float floatValue() { return value; } + /** + * Returns the value of this MutableLong as a double. + * + * @return the numeric value represented by this object after conversion to type double. + */ public double doubleValue() { return value; } Modified: jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableShort.java URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableShort.java?view=diff&r1=151303&r2=151304 ============================================================================== --- jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableShort.java (original) +++ jakarta/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableShort.java Thu Feb 3 19:07:18 2005 @@ -21,7 +21,7 @@ * * @see Short * @since 2.1 - * @version $Id: MutableShort.java,v 1.6 2004/10/08 19:45:46 ggregory Exp $ + * @version $Id$ */ public class MutableShort extends Number implements Comparable, Mutable { @@ -97,22 +97,48 @@ } //----------------------------------------------------------------------- + // bytValue relies on Number implementation + /** + * Returns the value of this MutableShort as a short. + * + * @return the numeric value represented by this object after conversion to type short. + */ public short shortValue() { return value; } + /** + * Returns the value of this MutableShort as a int. + * + * @return the numeric value represented by this object after conversion to type int. + */ public int intValue() { return value; } + /** + * Returns the value of this MutableShort as a long. + * + * @return the numeric value represented by this object after conversion to type long. + */ public long longValue() { return value; } + /** + * Returns the value of this MutableShort as a float. + * + * @return the numeric value represented by this object after conversion to type float. + */ public float floatValue() { return value; } + /** + * Returns the value of this MutableShort as a double. + * + * @return the numeric value represented by this object after conversion to type double. + */ public double doubleValue() { return value; } --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]