Changeset 9980 in josm for trunk/src/org/openstreetmap/josm/data/osm

Timestamp:

2016-03-13T16:31:38+01:00 (8 years ago)

Author:

Don-vip

Message:

sonar - code style + javadoc

Location:

trunk/src/org/openstreetmap/josm/data/osm

Files:

• Filter.java (modified) (3 diffs)
• Storage.java (modified) (7 diffs)

trunk/src/org/openstreetmap/josm/data/osm/Filter.java

@@ -11 +11 @@
  *
  * @author Petr_Dlouhý
+ * @since 2125
  */
 public class Filter extends SearchSetting {
     private static final String version = "1";
 
+    /**
+     * Enabled status.
+     * @see FilterPreferenceEntry#enable
+     */
     public boolean enable = true;
+
+    /**
+     * If this option is activated, the chosen objects are completely hidden.
+     * Otherwise they are disabled and shown in a shade of gray.
+     * @see FilterPreferenceEntry#hiding
+     */
     public boolean hiding;
+
+    /**
+     * Normally, the specified objects are hidden and the rest is shown.
+     * If this option is activated, only the specified objects are shown and the rest is hidden.
+     * @see FilterPreferenceEntry#inverted
+     */
     public boolean inverted;
 
@@ -27 +44 @@
     }
 
+    /**
+     * Constructs a new {@code Filter} from a preference entry.
+     * @param e preference entry
+     */
     public Filter(FilterPreferenceEntry e) {
         this();
@@ -48 +69 @@
 
     public static class FilterPreferenceEntry {
-        @pref @writeExplicitly public String version = "1";
+        @writeExplicitly
+        @pref public String version = "1";
+
         @pref public String text;
-        @pref @writeExplicitly public String mode = "add";
+
+        /**
+         * Mode selector which defines how a filter is combined with the previous one:<ul>
+         * <li>replace: replace selection</li>
+         * <li>add: add to selection</li>
+         * <li>remove: remove from selection</li>
+         * <li>in_selection: find in selection</li>
+         * </ul>
+         * @see SearchMode
+         */
+        @writeExplicitly
+        @pref public String mode = "add";
+
         @pref public boolean case_sensitive;
+
         @pref public boolean regex_search;
+
         @pref public boolean mapCSS_search;
-        @pref @writeExplicitly public boolean enable = true;
-        @pref @writeExplicitly public boolean hiding;
-        @pref @writeExplicitly public boolean inverted;
+
+        /**
+         * Enabled status.
+         * @see Filter#enable
+         */
+        @writeExplicitly
+        @pref public boolean enable = true;
+
+        /**
+         * If this option is activated, the chosen objects are completely hidden.
+         * Otherwise they are disabled and shown in a shade of gray.
+         * @see Filter#hiding
+         */
+        @writeExplicitly
+        @pref public boolean hiding;
+
+        /**
+         * Normally, the specified objects are hidden and the rest is shown.
+         * If this option is activated, only the specified objects are shown and the rest is hidden.
+         * @see Filter#inverted
+         */
+        @writeExplicitly
+        @pref public boolean inverted;
     }
 
+    /**
+     * Returns a new preference entry for this filter.
+     * @return preference entry
+     */
     public FilterPreferenceEntry getPreferenceEntry() {
         FilterPreferenceEntry e = new FilterPreferenceEntry();

trunk/src/org/openstreetmap/josm/data/osm/Storage.java

@@ -144 +144 @@
         this.hash = ha;
         int cap = 1 << (int) (Math.ceil(Math.log(capacity/LOAD_FACTOR) / Math.log(2)));
-        @SuppressWarnings("unchecked") T[] newData = (T[]) new Object[cap];
+        @SuppressWarnings("unchecked")
+        T[] newData = (T[]) new Object[cap];
         data = newData;
         mask = data.length - 1;
@@ -175 +176 @@
     @Override
     public synchronized boolean contains(Object o) {
-        @SuppressWarnings("unchecked") T t = (T) o;
+        @SuppressWarnings("unchecked")
+        T t = (T) o;
         int bucket = getBucket(hash, t);
         return bucket >= 0;
@@ -188 +190 @@
     @Override
     public synchronized boolean remove(Object o) {
-        @SuppressWarnings("unchecked") T t = (T) o;
+        @SuppressWarnings("unchecked")
+        T t = (T) o;
         T tOrig = removeElem(t);
         return tOrig != null;
@@ -329 +332 @@
     private void ensureSpace() {
         if (size > data.length*LOAD_FACTOR) { // rehash
-            @SuppressWarnings("unchecked") T[] big = (T[]) new Object[data.length * 2];
+            @SuppressWarnings("unchecked")
+            T[] big = (T[]) new Object[data.length * 2];
             int nMask = big.length - 1;
 
@@ -387 +391 @@
         @Override
         public boolean containsKey(Object o) {
-            @SuppressWarnings("unchecked") K key = (K) o;
+            @SuppressWarnings("unchecked")
+            K key = (K) o;
             int bucket = getBucket(fHash, key);
             return bucket >= 0;
@@ -399 +404 @@
         @Override
         public T get(Object o) {
-            @SuppressWarnings("unchecked") K key = (K) o;
+            @SuppressWarnings("unchecked")
+            K key = (K) o;
             int bucket = getBucket(fHash, key);
             return bucket < 0 ? null : data[bucket];
@@ -414 +420 @@
             synchronized (Storage.this) {
                 modCount++;
-                @SuppressWarnings("unchecked") K key = (K) o;
+                @SuppressWarnings("unchecked")
+                K key = (K) o;
                 int bucket = getBucket(fHash, key);