Changeset 12151 in josm


Ignore:
Timestamp:
2017-05-15T12:50:02+02:00 (2 months ago)
Author:
michael2402
Message:

AbstractListMergeModel: Add documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/gui/conflict/pair/AbstractListMergeModel.java

    r11747 r12151  
    7676 */
    7777public abstract class AbstractListMergeModel<T extends PrimitiveId, C extends ConflictResolveCommand> extends ChangeNotifier {
     78    /**
     79     * The property name to listen for frozen changes.
     80     * @see #setFrozen(boolean)
     81     * @see #isFrozen()
     82     */
    7883    public static final String FROZEN_PROP = AbstractListMergeModel.class.getName() + ".frozen";
    7984
     
    230235            PropertyChangeEvent evt = new PropertyChangeEvent(this, FROZEN_PROP, oldValue, newValue);
    231236            listeners.forEach(listener -> listener.propertyChange(evt));
    232             }
    233         }
    234 
     237        }
     238    }
     239
     240    /**
     241     * Sets the frozen status for this model.
     242     * @param isFrozen <code>true</code> if it should be frozen.
     243     */
    235244    public final void setFrozen(boolean isFrozen) {
    236245        boolean oldValue = this.isFrozen;
     
    239248    }
    240249
     250    /**
     251     * Check if the model is frozen.
     252     * @return The current frozen state.
     253     */
    241254    public final boolean isFrozen() {
    242255        return isFrozen;
     
    398411    }
    399412
     413    /**
     414     * Copies over all values from the given side to the merged table..
     415     * @param source The source side to copy from.
     416     */
    400417    public void copyAll(ListRole source) {
    401418        getMergedEntries().clear();
     
    567584     */
    568585    protected boolean myAndTheirEntriesEqual() {
    569 
    570586        if (getMyEntriesSize() != getTheirEntriesSize())
    571587            return false;
     
    704720        }
    705721
     722        /**
     723         * Get the role of the table.
     724         * @return The role.
     725         */
    706726        public ListRole getRole() {
    707727            return role;
Note: See TracChangeset for help on using the changeset viewer.