Changeset 10137 in josm for trunk/src/org/openstreetmap/josm/gui/tagging

Timestamp:

2016-04-10T23:53:54+02:00 (8 years ago)

Author:

Don-vip

Message:

sonar, javadoc

Location:

trunk/src/org/openstreetmap/josm/gui/tagging/ac

Files:

• AutoCompletionItemPriority.java (modified) (4 diffs)
• AutoCompletionList.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/gui/tagging/ac/AutoCompletionItemPriority.java

@@ -7 +7 @@
  *
  * Instances of this class are not modifiable.
+ * @since 1762
  */
 public class AutoCompletionItemPriority implements Comparable<AutoCompletionItemPriority> {
@@ -44 +45 @@
     private final boolean selected;
 
-
     /**
-     * Create new AutoCompletionItemPriority object.
+     * Constructs a new {@code AutoCompletionItemPriority}.
      *
      * @param inDataSet true, if the item is found in the currently active data layer
-     * @param inStandard true, if the item is a standard tag, e.g. from the presets.
+     * @param inStandard true, if the item is a standard tag, e.g. from the presets
      * @param selected true, if it is found on an object that is currently selected
      * @param userInput null, if the user hasn't entered this tag so far. A number when
@@ -62 +62 @@
     }
 
+    /**
+     * Constructs a new {@code AutoCompletionItemPriority}.
+     *
+     * @param inDataSet true, if the item is found in the currently active data layer
+     * @param inStandard true, if the item is a standard tag, e.g. from the presets
+     * @param selected true, if it is found on an object that is currently selected
+     */
     public AutoCompletionItemPriority(boolean inDataSet, boolean inStandard, boolean selected) {
         this(inDataSet, inStandard, selected, NO_USER_INPUT);
     }
 
+    /**
+     * Determines if the item is found in the currently active data layer.
+     * @return {@code true} if the item is found in the currently active data layer
+     */
     public boolean isInDataSet() {
         return inDataSet;
     }
 
+    /**
+     * Determines if the item is a standard tag, e.g. from the presets.
+     * @return {@code true} if the item is a standard tag, e.g. from the presets
+     */
     public boolean isInStandard() {
         return inStandard;
     }
 
+    /**
+     * Determines if it is found on an object that is currently selected.
+     * @return {@code true} if it is found on an object that is currently selected
+     */
     public boolean isSelected() {
         return selected;
     }
 
+    /**
+     * Returns a number when the tag key / value has been entered by the user before.
+     * A lower number means this happened more recently and beats a higher number in priority.
+     * @return a number when the tag key / value has been entered by the user before.
+     *         {@code null}, if the user hasn't entered this tag so far.
+     */
     public Integer getUserInput() {
         return userInput == NO_USER_INPUT ? null : userInput;
@@ -89 +114 @@
     public int compareTo(AutoCompletionItemPriority other) {
         int ui = Integer.compare(other.userInput, userInput);
-        if (ui != 0) return ui;
+        if (ui != 0)
+            return ui;
 
         int sel = Boolean.valueOf(selected).compareTo(other.selected);
-        if (sel != 0) return sel;
+        if (sel != 0)
+            return sel;
 
         int ds = Boolean.valueOf(inDataSet).compareTo(other.inDataSet);
-        if (ds != 0) return ds;
+        if (ds != 0)
+            return ds;
 
         int std = Boolean.valueOf(inStandard).compareTo(other.inStandard);
-        if (std != 0) return std;
+        if (std != 0)
+            return std;
 
         return 0;

trunk/src/org/openstreetmap/josm/gui/tagging/ac/AutoCompletionList.java

@@ -28 +28 @@
  * AutoCompletionList is an {@link AbstractTableModel} which serves the list of filtered
  * items to a {@link JTable}.
- *
+ * @since 1762
  */
 public class AutoCompletionList extends AbstractTableModel {
@@ -67 +67 @@
     /**
      * clears the current filter
-     *
      */
     public void clearFilter() {
@@ -135 +134 @@
      */
     public void add(Collection<String> values, AutoCompletionItemPriority priority) {
-        if (values == null) return;
-        for (String value: values) {
+        if (values == null)
+            return;
+        for (String value : values) {
             if (value == null) {
                 continue;
@@ -148 +148 @@
     }
 
+    /**
+     * Adds values that have been entered by the user.
+     * @param values values that have been entered by the user
+     */
     public void addUserInput(Collection<String> values) {
-        if (values == null) return;
+        if (values == null)
+            return;
         int i = 0;
-        for (String value: values) {
-            if (value == null) {
-                continue;
-            }
-            AutoCompletionListItem item = new AutoCompletionListItem(value, new AutoCompletionItemPriority(false, false, false, i));
-            appendOrUpdatePriority(item);
-            i++;
+        for (String value : values) {
+            if (value != null) {
+                appendOrUpdatePriority(
+                        new AutoCompletionListItem(value, new AutoCompletionItemPriority(false, false, false, i++)));
+            }
         }
         sort();