Changeset 12151 in josm for trunk

Timestamp:

2017-05-15T12:50:02+02:00 (8 years ago)

Author:

michael2402

Message:

AbstractListMergeModel: Add documentation

File:

• trunk/src/org/openstreetmap/josm/gui/conflict/pair/AbstractListMergeModel.java (modified) (6 diffs)

trunk/src/org/openstreetmap/josm/gui/conflict/pair/AbstractListMergeModel.java

@@ -76 +76 @@
  */
 public abstract class AbstractListMergeModel<T extends PrimitiveId, C extends ConflictResolveCommand> extends ChangeNotifier {
+    /**
+     * The property name to listen for frozen changes.
+     * @see #setFrozen(boolean)
+     * @see #isFrozen()
+     */
     public static final String FROZEN_PROP = AbstractListMergeModel.class.getName() + ".frozen";
 
@@ -230 +235 @@
             PropertyChangeEvent evt = new PropertyChangeEvent(this, FROZEN_PROP, oldValue, newValue);
             listeners.forEach(listener -> listener.propertyChange(evt));
-            }
-        }
-
+        }
+    }
+
+    /**
+     * Sets the frozen status for this model.
+     * @param isFrozen <code>true</code> if it should be frozen.
+     */
     public final void setFrozen(boolean isFrozen) {
         boolean oldValue = this.isFrozen;
@@ -239 +248 @@
     }
 
+    /**
+     * Check if the model is frozen.
+     * @return The current frozen state.
+     */
     public final boolean isFrozen() {
         return isFrozen;
@@ -398 +411 @@
     }
 
+    /**
+     * Copies over all values from the given side to the merged table..
+     * @param source The source side to copy from.
+     */
     public void copyAll(ListRole source) {
         getMergedEntries().clear();
@@ -567 +584 @@
      */
     protected boolean myAndTheirEntriesEqual() {
-
         if (getMyEntriesSize() != getTheirEntriesSize())
             return false;
@@ -704 +720 @@
         }
 
+        /**
+         * Get the role of the table.
+         * @return The role.
+         */
         public ListRole getRole() {
             return role;