Changeset 19 for src/main/java/geniusweb/profilesserver

Timestamp:

10/06/20 13:12:24 (4 years ago)

Author:

bart

Message:

Fixes an issue with processing maxPower of a vote. Javadoc maven plugin now uses latest version.

Location:

src/main/java/geniusweb/profilesserver

Files:

• AutoUpdatingProfilesRepository.java (modified) (2 diffs)
• DefaultProfilesRepository.java (modified) (1 diff)
• Jackson.java (modified) (1 diff)
• ProfilesRepository.java (modified) (1 diff)
• events/ProfileChangeEvent.java (modified) (1 diff)
• websocket/GetProfileSocket.java (modified) (1 diff)

src/main/java/geniusweb/profilesserver/AutoUpdatingProfilesRepository.java

@@ -367 +367 @@
          * {@link FileWatcher}.
          * 
-         * @param file
+         * @param file the file/dir to watch
          * @return a class that watches for file changes below the given file.
          */
@@ -380 +380 @@
          * @return the root dir of the repo. This is the 'database' where all known
          *         profiles are stored.
-         * @throws URISyntaxException
          */
         protected Path getRootDir() {

src/main/java/geniusweb/profilesserver/DefaultProfilesRepository.java

@@ -33 +33 @@
          * all currently available profiles and domains. Invariant for this class:
          * All {@link Domain}s in this map have a unique name that matches the
-         * directory name and file name on the file system below {@link #dir}. All
-         * profile values in the map their {@link Profile#getDomain()} match with
-         * the domain key in the map.
+         * directory name and file name on the file system below the given
+         * directory. All profile values in the map their
+         * {@link Profile#getDomain()} match with the domain key in the map.
          */
         protected final Map<Domain, List<Profile>> available = new ConcurrentHashMap<>();

src/main/java/geniusweb/profilesserver/Jackson.java

@@ -9 +9 @@
  * 
  * <b> This class should is private to the profiles server and should not be
- * used by others.
+ * used by others.</b>
  */
 public class Jackson {

src/main/java/geniusweb/profilesserver/ProfilesRepository.java

@@ -22 +22 @@
 
         /**
-         * @param simple profilename of the form "domainname/profileX" (no
-         *               extendsions).
-         * @return profile with the given name and the given domain, or null if no
-         *         such domain or profile exists.
+         * @param profilename simple profile name of the form "domainname/profileX"
+         *                    (no extendsions).
+         * @return {@link Profile} with the given name and the given domain, or null
+         *         if no such domain or profile exists.
          * 
          */

src/main/java/geniusweb/profilesserver/events/ProfileChangeEvent.java

@@ -7 +7 @@
 
         /**
-         * 
-         * @param type the {@link ModificationType} of this event.
-         * 
-         * @param old  the profile before the change. Null if it was added.
-         * @param      new the profile after the change. Null if it was removed
+         * @param oldprof the profile before the change. Null if it was added.
+         * @param newprof the profile after the change. Null if it was removed
          */
         public ProfileChangeEvent(Profile oldprof, Profile newprof) {

src/main/java/geniusweb/profilesserver/websocket/GetProfileSocket.java

@@ -41 +41 @@
  * 
  * <p>
- * Query string: the websocket allows query strings.
- * <ul>
- * <li>partial</li> a query key that is assigned a natural number N (0 or
- * larger). If set, the profile is converted into a Partial Profile with the
- * given number of points. If N>0, the maximum utility bid is included .If N>1,
- * the minimum utility bid is included. The other bids are picked at random.
- * This filtering mechanism only works if the profile is {@link LinearAdditive}
- * space. The reservation bid is passed through unmodified.
+ * Query strings: the websocket allows query strings. Allowed:
+ * <table>
+ * <caption>Query strings for GetprofileSocket</caption>
+ * <tr>
+ * <th>query name</th>
+ * <th>description</th>
+ * </tr>
+ * <tr>
+ * <td>partial=N</td>
+ * <td>a query key that is assigned a natural number N (0 or larger). If set,
+ * the profile is converted into a Partial Profile with the given number of
+ * points. If N&gt;0, the maximum utility bid is included .If N&gt;1, the
+ * minimum utility bid is included. The other bids are picked at random. This
+ * filtering mechanism only works if the profile is {@link LinearAdditive}
+ * space. The reservation bid is passed through unmodified.</td>
+ * </tr>
+ * </table>
  */
 @ServerEndpoint("/websocket/get/{domain}/{profile}")