svn commit: r15991 - trunk/src/argouml-app/src/org/argouml/cognitive/ToDoItem.java

Author: bobtarling
Date: 2008-11-08 08:44:36-0800
New Revision: 15991

Modified:
   trunk/src/argouml-app/src/org/argouml/cognitive/ToDoItem.java

Log:
Deprecate the mutators with the intention that we force immutability of this class.

Modified: trunk/src/argouml-app/src/org/argouml/cognitive/ToDoItem.java
Url: http://argouml.tigris.org/source/browse/argouml/trunk/src/argouml-app/src/org/argouml/cognitive/ToDoItem.java?view=diff&rev=15991&p1=trunk/src/argouml-app/src/org/argouml/cognitive/ToDoItem.java&p2=trunk/src/argouml-app/src/org/argouml/cognitive/ToDoItem.java&r1=15990&r2=15991
==============================================================================
--- trunk/src/argouml-app/src/org/argouml/cognitive/ToDoItem.java	(original)
+++ trunk/src/argouml-app/src/org/argouml/cognitive/ToDoItem.java	2008-11-08 08:44:36-0800
@@ -215,6 +215,8 @@
     /**
      * Override in subclass to validate the offender is an expected type.
      * @param dm the offender (why dm?)
+     * TODO: Can someone explain the variable name dm and a more descriptive
+     * alternative?
      */
     protected void checkArgument(Object dm) {
     }
@@ -263,9 +265,9 @@
     }
 
     /**
-     * @deprecated A ToDoItem should be immutable to guarantee it can be
-     * passed safely between threads. Only use the constructor to set this
-     * value.
+     * @deprecated in 0.27.2 byb Bob Tarling. A ToDoItem should be immutable
+     * to guarantee it can be passed safely between threads. Only use the
+     * constructor to set this value.
      * @param h the headline
      */
     @Deprecated
@@ -286,11 +288,12 @@
     }
 
     /**
-     * @deprecated A ToDoItem should be immutable to guarantee it can be
-     * passed safely between threads. Only use the constructor to set this
-     * value.
+     * @deprecated in 0.27.2 byb Bob Tarling. A ToDoItem should be immutable
+     * to guarantee it can be passed safely between threads. Only use the
+     * constructor to set this value.
      * @param d the description
      */
+    @Deprecated
     public void setDescription(String d) {
 	theDescription = d;
 	cachedExpandedDescription = null;
@@ -302,11 +305,12 @@
     public String getMoreInfoURL() { return theMoreInfoURL; }
 
     /**
-     * @deprecated A ToDoItem should be immutable to guarantee it can be
-     * passed safely between threads. Only use the constructor to set this
-     * value.
+     * @deprecated in 0.27.2 byb Bob Tarling. A ToDoItem should be immutable
+     * to guarantee it can be passed safely between threads. Only use the
+     * constructor to set this value.
      * @param m the more-info-url
      */
+    @Deprecated
     public void setMoreInfoURL(String m) {
         theMoreInfoURL = m;
     }
@@ -317,11 +321,12 @@
     public int getPriority() { return thePriority; }
 
     /**
-     * @deprecated A ToDoItem should be immutable to guarantee it can be
-     * passed safely between threads. Only use the constructor to set this
-     * value.
+     * @deprecated in 0.27.2 by Bob Tarling. A ToDoItem should be immutable
+     * to guarantee it can be passed safely between threads. Only use the
+     * constructor to set this value.
      * @param p the priority
      */
+    @Deprecated
     public void setPriority(int p) {
         thePriority = p;
     }
@@ -358,8 +363,12 @@
      * TODO: Offenders need to be more strongly typed. - tfm 20070630
      * TODO: Provide a constructor argument for this so that the class can
      * become immutable
+     * @deprecated in 0.27.2 by Bob Tarling. A ToDoItem should be immutable
+     * to guarantee it can be passed safely between threads. Only use the
+     * constructor to set this value.
      */
-    public void setOffenders(ListSet offenders) {
+    @Deprecated
+    protected void setOffenders(ListSet offenders) {
         theOffenders = offenders;
     }