Changeset 21 for src/main/java/geniusweb/partiesserver/repository/RunningParty.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.

File:

• src/main/java/geniusweb/partiesserver/repository/RunningParty.java (modified) (7 diffs)

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) {