Changeset 10125 in josm for trunk/src/org/openstreetmap/josm/gui/correction/CorrectionTableModel.java

Timestamp:

2016-04-09T17:07:54+02:00 (8 years ago)

Author:

Don-vip

Message:

refactor classes from corrector package, add javadoc

Location:

trunk/src/org/openstreetmap/josm/gui/correction

Files:

• . (added)
• CorrectionTableModel.java (moved) (moved from trunk/src/org/openstreetmap/josm/corrector/CorrectionTableModel.java ) (4 diffs)

trunk/src/org/openstreetmap/josm/gui/correction/CorrectionTableModel.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
-package org.openstreetmap.josm.corrector;
+package org.openstreetmap.josm.gui.correction;
 
 import static org.openstreetmap.josm.tools.I18n.tr;
@@ -9 +9 @@
 import javax.swing.table.AbstractTableModel;
 
+import org.openstreetmap.josm.data.correction.Correction;
+
+/**
+ * Abstract correction table model.
+ * @param <C> type of correction
+ */
 public abstract class CorrectionTableModel<C extends Correction> extends AbstractTableModel {
 
@@ -15 +21 @@
     private final int applyColumn;
 
+    /**
+     * Constructs a new {@code CorrectionTableModel}.
+     * @param corrections list of corrections
+     */
     public CorrectionTableModel(List<C> corrections) {
         this.corrections = corrections;
@@ -27 +37 @@
     protected abstract boolean isBoldCell(int row, int column);
 
+    /**
+     * Returns the column name for columns other than "Apply".
+     * @param colIndex column index
+     * @return the translated column name for given index
+     * @see #getApplyColumn
+     */
     public abstract String getCorrectionColumnName(int colIndex);
 
+    /**
+     * Returns the correction value at given position.
+     * @param rowIndex row index
+     * @param colIndex column index
+     * @return the correction value at given position
+     */
     public abstract Object getCorrectionValueAt(int rowIndex, int colIndex);
 
+    /**
+     * Returns the list of corrections.
+     * @return the list of corrections
+     */
     public List<C> getCorrections() {
         return corrections;
     }
 
+    /**
+     * Returns the index of the "Apply" column.
+     * @return the index of the "Apply" column
+     */
     public int getApplyColumn() {
         return applyColumn;
     }
 
+    /**
+     * Returns the "Apply" flag for given index.
+     * @param i index
+     * @return the "Apply" flag for given index
+     */
     public boolean getApply(int i) {
         return apply[i];