commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From scolebou...@apache.org
Subject svn commit: r830027 - /commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableObject.java
Date Mon, 26 Oct 2009 23:49:25 GMT
Author: scolebourne
Date: Mon Oct 26 23:49:25 2009
New Revision: 830027

URL: http://svn.apache.org/viewvc?rev=830027&view=rev
Log:
Javadoc clarifications and tidy

Modified:
    commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableObject.java

Modified: commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableObject.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableObject.java?rev=830027&r1=830026&r2=830027&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableObject.java
(original)
+++ commons/proper/lang/trunk/src/java/org/apache/commons/lang/mutable/MutableObject.java
Mon Oct 26 23:49:25 2009
@@ -47,8 +47,7 @@
     /**
      * Constructs a new MutableObject with the specified value.
      * 
-     * @param value
-     *            a value.
+     * @param value  the initial value to store
      */
     public MutableObject(T value) {
         super();
@@ -59,7 +58,7 @@
     /**
      * Gets the value.
      * 
-     * @return the value
+     * @return the value, may be null
      */
     public T getValue() {
         return this.value;
@@ -68,8 +67,7 @@
     /**
      * Sets the value.
      * 
-     * @param value
-     *            the value to set
+     * @param value  the value to set
      */
     public void setValue(T value) {
         this.value = value;
@@ -81,8 +79,7 @@
      * is not <code>null</code> and is a <code>MutableObject</code>
object that contains the same <code>T</code>
      * value as this object.
      * 
-     * @param obj
-     *            the object to compare with.
+     * @param obj  the object to compare with, null returns false
      * @return <code>true</code> if the objects are the same; <code>false</code>
otherwise.
      */
     public boolean equals(MutableObject<T> obj) {
@@ -104,6 +101,7 @@
         return value == null ? 0 : value.hashCode();
     }
 
+    //-----------------------------------------------------------------------
     /**
      * Returns the String value of this mutable.
      * 



Mime
View raw message