Changeset 21 for src/main/java

Timestamp:

10/06/20 13:12:31 (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/partiesserver

Files:

• Info.java (modified) (1 diff)
• RunParty.java (modified) (1 diff)
• repository/AvailableParty.java (modified) (1 diff)
• repository/RunningParty.java (modified) (7 diffs)
• websocket/PartySocket.java (modified) (2 diffs)

src/main/java/geniusweb/partiesserver/Info.java

@@ -23 +23 @@
 
         /**
-         * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse
-         *      response). Returns
-         *      <ul>
-         *      <li>URL with websocket address to contact the now running agent.
-         *      <li>SC_NOT_FOUND (404) if attempt is made to access non-running
-         *      party.
-         *      <li>SC_SERVICE_UNAVAILABLE (503) if there are no free slots to run
-         *      the party.
-         *      <li>SC_EXPECTATION_FAILED (417) if something else goes wrong during
-         *      instantiating the party (then see logs for more details)
-         *      </ul>
+         * see
+         * {@link HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)}.
+         * Returns to the http caller
+         * <ul>
+         * <li>URL with websocket address to contact the now running agent.
+         * <li>SC_NOT_FOUND (404) if attempt is made to access non-running party.
+         * <li>SC_SERVICE_UNAVAILABLE (503) if there are no free slots to run the
+         * party.
+         * <li>SC_EXPECTATION_FAILED (417) if something else goes wrong during
+         * instantiating the party (then see logs for more details)
+         * </ul>
          */
         @Override

src/main/java/geniusweb/partiesserver/RunParty.java

@@ -43 +43 @@
 
         /**
-         * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse
-         *      response). Returns
-         *      <ul>
-         *      <li>URL with websocket address to contact the now running agent.
-         *      <li>SC_NOT_FOUND (404) if attempt is made to access non-running
-         *      party.
-         *      <li>SC_SERVICE_UNAVAILABLE (503) if there are no free slots to run
-         *      the party.
-         *      <li>SC_EXPECTATION_FAILED (417) if something else goes wrong during
-         *      instantiating the party (then see logs for more details)
-         *      </ul>
+         * See
+         * {@link HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)}.
+         * Returns
+         * <ul>
+         * <li>URL with websocket address to contact the now running agent.
+         * <li>SC_NOT_FOUND (404) if attempt is made to access non-running party.
+         * <li>SC_SERVICE_UNAVAILABLE (503) if there are no free slots to run the
+         * party.
+         * <li>SC_EXPECTATION_FAILED (417) if something else goes wrong during
+         * instantiating the party (then see logs for more details)
+         * </ul>
          */
         @Override

src/main/java/geniusweb/partiesserver/repository/AvailableParty.java

@@ -17 +17 @@
          * @param name       the filename. This is not a {@link PartyId}.
          * @param partyclass the class of the party.
-         * @throws IllegalAccessException
-         * @throws InstantiationException
+         * @throws ClassNotFoundException if unknown partyclass
          */
         public AvailableParty(String name, Class<? extends Party> partyclass)

src/main/java/geniusweb/partiesserver/repository/RunningParty.java

@@ -10 +10 @@
 
 import geniusweb.actions.PartyId;
-import geniusweb.connection.DefaultConnection;
 import geniusweb.inform.Inform;
 import geniusweb.partiesserver.RunningPartiesUpdater;
@@ -52 +51 @@
          * @param party the new party
          * @param id    the new id for the party.
+         * @param name  the name, this should match the filename
          * @param start the start date for this party. Usually set to current time.
          * @param end   the end date for this party
@@ -72 +72 @@
 
         /**
-         * Create instance from availableparty
-         * 
          * @param availableparty the {@link AvailableParty}
-         * @param name           the (file)name
          * @param maxlifetimems  the maximum life time for this party (ms). The
          *                       party will be killed and removed after this point.
@@ -81 +78 @@
          *                       time plus the worst time to actual start up of the
          *                       negotiation
-         * @throws IllegalAccessException
-         * @throws InstantiationException
+         * @return a new RunningParty being an instance of availableparty
+         * @throws IllegalAccessException if the class or its nullary constructor is
+         *                                not accessible.
+         * 
+         * @throws InstantiationException if this Class represents an abstract
+         *                                class, an interface, an array class, a
+         *                                primitive type, or void; or if the class
+         *                                has no nullary constructor; or if the
+         *                                instantiation fails for some other reason.
+         * 
          */
         public static RunningParty create(AvailableParty availableparty,
@@ -104 +109 @@
          *                     {@link RunningPartiesUpdater} will keep an eye on the
          *                     time and handle removal after time is up.
-         * 
-         */
-        public static RunningParty create(Party party, String name,
+         * @return new RunningParty created from the Party instance.
+         * 
+         */
+        private static RunningParty create(Party party, String name,
                         long maxRunTimeMS) {
                 if (maxRunTimeMS <= 0) {
@@ -133 +139 @@
 
         /**
-         * The name, this should match the filename in the repo (without the .jar).
-         * 
-         * @return
+         * @return The name, this should match the filename in the repo (without the
+         *         .jar).
+         * 
          */
         public String getName() {
@@ -207 +213 @@
 
         /**
-         * You must have called {@link #connect(DefaultConnection)} before calling
+         * You must have called {@link #withConnection(PartySocket)} before calling
          * this.
          * 
-         * @param info
+         * @param info the {@link Inform} to be sent to the {@link #connection}
          */
         public void inform(Inform info) {

src/main/java/geniusweb/partiesserver/websocket/PartySocket.java

@@ -19 +19 @@
 import javax.websocket.server.ServerEndpoint;
 
-import com.fasterxml.jackson.core.JsonParseException;
-import com.fasterxml.jackson.databind.JsonMappingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
@@ -124 +122 @@
          *                      {@link Inform}
          * @param session       the session. We already have this info.
+         * @throws IOException if there is a socket/connection error, we can't parse
+         *                     the received data, etc
          */
         @OnMessage
         public void onMessage(String informmessage, Session session)
-                        throws JsonParseException, JsonMappingException, IOException {
+                        throws IOException {
                 if (this.session != session) {
                         throw new IllegalStateException("Unexpected change of session ID");