svn commit: r737686 - /incubator/uima/sandbox/trunk/CasEditorEclipsePlugin/src/main/java/org/apache/uima/caseditor/editor/EditorAnnotationStatus.java

[jo...@apache.org]

Author: joern
Date: Mon Jan 26 13:12:46 2009
New Revision: 737686

URL: http://svn.apache.org/viewvc?rev=737686&view=rev
Log:
UIMA-546 Added class javadoc comment

Modified:
    incubator/uima/sandbox/trunk/CasEditorEclipsePlugin/src/main/java/org/apache/uima/caseditor/editor/EditorAnnotationStatus.java

Modified: incubator/uima/sandbox/trunk/CasEditorEclipsePlugin/src/main/java/org/apache/uima/caseditor/editor/EditorAnnotationStatus.java
URL: http://svn.apache.org/viewvc/incubator/uima/sandbox/trunk/CasEditorEclipsePlugin/src/main/java/org/apache/uima/caseditor/editor/EditorAnnotationStatus.java?rev=737686&r1=737685&r2=737686&view=diff
==============================================================================
--- incubator/uima/sandbox/trunk/CasEditorEclipsePlugin/src/main/java/org/apache/uima/caseditor/editor/EditorAnnotationStatus.java (original)
+++ incubator/uima/sandbox/trunk/CasEditorEclipsePlugin/src/main/java/org/apache/uima/caseditor/editor/EditorAnnotationStatus.java Mon Jan 26 13:12:46 2009
@@ -25,12 +25,18 @@
 import org.apache.uima.cas.Type;
 
 /**
- * TODO: add javadoc here
+ * The {@link EditorAnnotationStatus} are editor settings which are associated with
+ * one project. 
+ *
+ * When a new editor is opened the {@link EditorAnnotationStatus} is used to
+ * initialize it, with that information the editor can show the same information
+ * as the previously opened editor. 
  */
 public class EditorAnnotationStatus {
-  private String mMode;
+	
+  private String mode;
 
-  private Collection<String> mDisplayAnnotations = new HashSet<String>();
+  private Collection<String> displayAnnotations = new HashSet<String>();
 
   /**
    * Initializes a new instance.
@@ -43,12 +49,12 @@
       throw new IllegalArgumentException("Mode must not be null!");
     }
 
-    mMode = mode;
+    this.mode = mode;
 
     if (displayAnnotations != null) {
 
       for (Type type : displayAnnotations) {
-        mDisplayAnnotations.add(type.getName());
+        this.displayAnnotations.add(type.getName());
       }
     }
   }
@@ -59,7 +65,7 @@
    * @return the editor mode
    */
   public String getMode() {
-    return mMode;
+    return mode;
   }
 
   /**
@@ -68,6 +74,6 @@
    * @return the display annotations
    */
   public Collection<String> getDisplayAnnotations() {
-    return mDisplayAnnotations;
+    return displayAnnotations;
   }
-}
\ No newline at end of file
+}