Changeset 9201 in josm for trunk

Timestamp:

2015-12-28T17:10:17+01:00 (8 years ago)

Author:

Don-vip

Message:

add more unit tests, javadoc

Location:

trunk

Files:

• src/org/openstreetmap/josm/data/oauth/OsmPrivileges.java (modified) (2 diffs)
• test/unit/org/openstreetmap/josm/data/oauth (added)
• test/unit/org/openstreetmap/josm/data/oauth/OAuthParametersTest.java (added)
• test/unit/org/openstreetmap/josm/data/oauth/OAuthTokenTest.java (added)
• test/unit/org/openstreetmap/josm/data/oauth/OsmPrivilegesTest.java (added)

trunk/src/org/openstreetmap/josm/data/oauth/OsmPrivileges.java

@@ -2 +2 @@
 package org.openstreetmap.josm.data.oauth;
 
+/**
+ * List of permissions granted to the current OSM connection.
+ * @since 2747
+ */
 public class OsmPrivileges {
     private boolean allowWriteApi;
@@ -10 +14 @@
     private boolean allowModifyNotes;
 
+    /**
+     * Determines if the client is allowed to modify the map.
+     * @return {@code true} if the client is allowed to modify the map, {@code false} otherwise
+     */
     public boolean isAllowWriteApi() {
         return allowWriteApi;
     }
 
+    /**
+     * Sets whether the client is allowed to modify the map.
+     * @param allowWriteApi {@code true} if the client is allowed to modify the map, {@code false} otherwise
+     */
     public void setAllowWriteApi(boolean allowWriteApi) {
         this.allowWriteApi = allowWriteApi;
     }
 
+    /**
+     * Determines if the client is allowed to upload GPS traces.
+     * @return {@code true} if the client is allowed to upload GPS traces, {@code false} otherwise
+     */
     public boolean isAllowWriteGpx() {
         return allowWriteGpx;
     }
 
+    /**
+     * Sets whether the client is allowed to upload GPS traces.
+     * @param allowWriteGpx {@code true} if the client is allowed to upload GPS traces, {@code false} otherwise
+     */
     public void setAllowWriteGpx(boolean allowWriteGpx) {
         this.allowWriteGpx = allowWriteGpx;
     }
 
+    /**
+     * Determines if the client is allowed to read private GPS traces.
+     * @return {@code true} if the client is allowed to read private GPS traces, {@code false} otherwise
+     */
     public boolean isAllowReadGpx() {
         return allowReadGpx;
     }
 
+    /**
+     * Sets whether the client is allowed to read private GPS traces.
+     * @param allowReadGpx {@code true} if the client is allowed to read private GPS traces, {@code false} otherwise
+     */
     public void setAllowReadGpx(boolean allowReadGpx) {
         this.allowReadGpx = allowReadGpx;
     }
 
+    /**
+     * Determines if the client is allowed to read user preferences.
+     * @return {@code true} if the client is allowed to read user preferences, {@code false} otherwise
+     */
     public boolean isAllowReadPrefs() {
         return allowReadPrefs;
     }
 
+    /**
+     * Sets whether the client is allowed to read user preferences.
+     * @param allowReadPrefs {@code true} if the client is allowed to read user preferences, {@code false} otherwise
+     */
     public void setAllowReadPrefs(boolean allowReadPrefs) {
         this.allowReadPrefs = allowReadPrefs;
     }
 
+    /**
+     * Determines if the client is allowed to modify user preferences.
+     * @return {@code true} if the client is allowed to modify user preferences, {@code false} otherwise
+     */
     public boolean isAllowWritePrefs() {
         return allowWritePrefs;
     }
 
+    /**
+     * Sets whether the client is allowed to modify user preferences.
+     * @param allowWritePrefs {@code true} if the client is allowed to modify user preferences, {@code false} otherwise
+     */
     public void setAllowWritePrefs(boolean allowWritePrefs) {
         this.allowWritePrefs = allowWritePrefs;
     }
 
+    /**
+     * Determines if the client is allowed to modify notes.
+     * @return {@code true} if the client is allowed to modify notes, {@code false} otherwise
+     */
     public boolean isAllowModifyNotes() {
         return allowModifyNotes;
     }
 
+    /**
+     * Sets whether the client is allowed to modify notes.
+     * @param allowModifyNotes {@code true} if the client is allowed to modify notes, {@code false} otherwise
+     */
     public void setAllowModifyNotes(boolean allowModifyNotes) {
         this.allowModifyNotes = allowModifyNotes;