[ALL] Doc updates

JPCatarino · Jun 7, 2020 · 67b5055 · 67b5055
1 parent 8f5cd09
commit 67b5055
Show file tree

Hide file tree

Showing 15 changed files with 110 additions and 76 deletions.
diff --git a/src/main/ArrivalLoungeServer.java b/src/main/ArrivalLoungeServer.java
@@ -10,26 +10,33 @@
 
 public class ArrivalLoungeServer {
 
+    /**
+     * Listening port number of the service provided
+     *
+     *  @serialField portNumb
+     */
     private static final int portNumb = 33002;
     public static int waitConnection;
 
-    public static void main (String [] args)
-    {
+    /**
+     *  Main program.
+     */
+
+    public static void main (String [] args) {
+
         ServiceProviderProxy serviceProviderProxy;
         ArrivalLoungeProxy arrivalLoungeProxy;
         ArrivalLounge arrivalLounge ;
         ServerCom scon, sconi;
 
         // Start service
-
         scon = new ServerCom(portNumb);
         scon.start ();
         arrivalLounge = new ArrivalLounge(new RepositoryStub("localhost", 33001));
         System.out.println ("O serviço foi estabelecido!");
         System.out.println ("O servidor esta em escuta.");
 
         // Process requests
-
         waitConnection = 0;
         while (waitConnection!=3)
             try
@@ -38,11 +45,8 @@ public static void main (String [] args)
                 serviceProviderProxy= new ServiceProviderProxy( arrivalLoungeProxy,sconi);
                 serviceProviderProxy.start ();
             }
-            catch (SocketTimeoutException e)
-            {
-            }
+            catch (SocketTimeoutException ignored) {}
         scon.end ();
         System.out.println ("O servidor foi desactivado.");
     }
-
 }
diff --git a/src/main/ArrivalQuayServer.java b/src/main/ArrivalQuayServer.java
@@ -11,26 +11,32 @@
 
 public class ArrivalQuayServer {
 
+    /**
+     * Listening port number of the service provided
+     *
+     *  @serialField portNumb
+     */
     private static final int portNumb = 33003;
     public static int waitConnection;
 
-    public static void main (String [] args)
-    {
+    /**
+     *  Main program.
+     */
+    public static void main (String [] args) {
+
         ServiceProviderProxy serviceProviderProxy;
         ArrivalQuayProxy arrivalQuayProxy;
         ArrivalQuay arrivalQuay ;
         ServerCom scon, sconi;
 
         // Start service
-
         scon = new ServerCom(portNumb);
         scon.start ();
         arrivalQuay = new ArrivalQuay(new RepositoryStub("localhost", 33001), new ArrivalLoungeStub("localhost", 33002));
         System.out.println ("O serviço foi estabelecido!");
         System.out.println ("O servidor esta em escuta.");
 
         // Process requests
-
         waitConnection = 0;
         while (waitConnection!=3)
             try
@@ -39,11 +45,8 @@ public static void main (String [] args)
                 serviceProviderProxy= new ServiceProviderProxy( arrivalQuayProxy,sconi);
                 serviceProviderProxy.start ();
             }
-            catch (SocketTimeoutException e)
-            {
-            }
+            catch (SocketTimeoutException ignored) {}
         scon.end ();
         System.out.println ("O servidor foi desactivado.");
     }
-
 }
diff --git a/src/main/ArrivalTerminalExitServer.java b/src/main/ArrivalTerminalExitServer.java
@@ -13,18 +13,25 @@
 
 public class ArrivalTerminalExitServer {
 
+    /**
+     * Listening port number of the service provided
+     *
+     *  @serialField portNumb
+     */
     private static final int portNumb = 33004;
     public static int waitConnection;
 
-    public static void main (String [] args)
-    {
+    /**
+     *  Main program.
+     */
+    public static void main (String [] args) {
+
         ServiceProviderProxy serviceProviderProxy;
         ArrivalTerminalExitProxy arrivalTerminalExitProxy;
         ArrivalTerminalExit arrivalTerminalExit ;
         ServerCom scon, sconi;
 
         // Start service
-
         scon = new ServerCom(portNumb);
         scon.start ();
         arrivalTerminalExit = new ArrivalTerminalExit(new RepositoryStub("localhost", 33001),new ArrivalLoungeStub("localhost", 33002), new DepartureTerminalEntranceStub("localhost", 33008));

diff --git a/src/main/BagColPointServer.java b/src/main/BagColPointServer.java
@@ -10,26 +10,32 @@
 
 public class BagColPointServer {
 
+    /**
+     * Listening port number of the service provided
+     *
+     *  @serialField portNumb
+     */
     private static final int portNumb = 33005;
     public static int waitConnection;
 
-    public static void main (String [] args)
-    {
+    /**
+     *  Main program.
+     */
+    public static void main (String [] args) {
+
         ServiceProviderProxy serviceProviderProxy;
         BagColPointProxy bagColPointProxy;
         BagColPoint bagColPoint ;
         ServerCom scon, sconi;
 
         // Start service
-
         scon = new ServerCom(portNumb);
         scon.start ();
         bagColPoint = new BagColPoint(new RepositoryStub("localhost", 33001));
         System.out.println ("O serviço foi estabelecido!");
         System.out.println ("O servidor esta em escuta.");
 
         // Process requests
-
         waitConnection = 0;
         while (waitConnection!=3)
             try
@@ -38,11 +44,8 @@ public static void main (String [] args)
                 serviceProviderProxy= new ServiceProviderProxy( bagColPointProxy,sconi);
                 serviceProviderProxy.start ();
             }
-            catch (SocketTimeoutException e)
-            {
-            }
+            catch (SocketTimeoutException ignored) {}
         scon.end ();
         System.out.println ("O servidor foi desactivado.");
     }
-
 }
diff --git a/src/main/BagRecOfficeServer.java b/src/main/BagRecOfficeServer.java
@@ -10,26 +10,32 @@
 
 public class BagRecOfficeServer {
 
+    /**
+     * Listening port number of the service provided
+     *
+     *  @serialField portNumb
+     */
     private static final int portNumb = 33006;
     public static int waitConnection;
 
-    public static void main (String [] args)
-    {
+    /**
+     *  Main program.
+     */
+    public static void main (String [] args) {
+
         ServiceProviderProxy serviceProviderProxy;
         BagRecOfficeProxy bagRecOfficeProxy;
         BagRecOffice bagRecOffice ;
         ServerCom scon, sconi;
 
         // Start service
-
         scon = new ServerCom(portNumb);
         scon.start ();
         bagRecOffice = new BagRecOffice(new RepositoryStub("localhost", 33001));
         System.out.println ("O serviço foi estabelecido!");
         System.out.println ("O servidor esta em escuta.");
 
         // Process requests
-
         waitConnection = 0;
         while (waitConnection!=3)
             try
@@ -38,11 +44,8 @@ public static void main (String [] args)
                 serviceProviderProxy= new ServiceProviderProxy( bagRecOfficeProxy,sconi);
                 serviceProviderProxy.start ();
             }
-            catch (SocketTimeoutException e)
-            {
-            }
+            catch (SocketTimeoutException ignored) {}
         scon.end ();
         System.out.println ("O servidor foi desactivado.");
     }
-
 }
diff --git a/src/main/ClientBusDriver.java b/src/main/ClientBusDriver.java
@@ -8,11 +8,9 @@ public class ClientBusDriver {
     public static void main(String[] args) {
 
         // Global variables.
-        int N_passengers = 6;
         int T_seats = 3;
 
-        //
-        String fName="Log.txt";                                 // logging file name
+        // Server global variables.
         String baseServerHostName = "localhost";                // name from the machine where the server is
         int baseServerPortNumb=33000;                           // server port number
 
@@ -43,6 +41,8 @@ public static void main(String[] args) {
             System.out.println(ex.getMessage());
             System.exit(1);
         }
+
+        //Shutdown
         arrivalLounge.shutdown(1);
         arrivalQuay.shutdown(1);
         arrivalTerminalExit.shutdown(1);

diff --git a/src/main/ClientPassenger.java b/src/main/ClientPassenger.java
@@ -26,8 +26,7 @@ public static void main(String[] args) {
         int M_luggage = 2;
         int T_seats = 3;
 
-        //
-        String fName="Log.txt";                                 // logging file name
+        // Server global variables.
         String baseServerHostName = "localhost";                // name from the machine where the server is
         int baseServerPortNumb=33000;                           // server port number
 
@@ -122,6 +121,7 @@ public static void main(String[] args) {
             plainBags.clear();
         }
 
+        //Shutdown
         arrivalLounge.shutdown(1);
         arrivalQuay.shutdown(1);
         arrivalTerminalExit.shutdown(1);

diff --git a/src/main/ClientPorter.java b/src/main/ClientPorter.java
@@ -10,10 +10,8 @@ public static void main(String[] args) {
         // Global variables.
         int K_landings = 5;
         int N_passengers = 6;
-        int T_seats = 3;
 
-        //
-        String fName="Log.txt";                                     // logging file name
+        // Server global variables.
         String baseServerHostName = "localhost";                    // name from the machine where the server is
         int baseServerPortNumb=33000;                               // server port number
 
@@ -44,6 +42,8 @@ public static void main(String[] args) {
             System.out.println(ex.getMessage());
             System.exit(1);
         }
+
+        //Shutdown
         arrivalLounge.shutdown(1);
         arrivalQuay.shutdown(1);
         arrivalTerminalExit.shutdown(1);

diff --git a/src/main/DepartureQuayServer.java b/src/main/DepartureQuayServer.java
@@ -10,26 +10,32 @@
 
 public class DepartureQuayServer {
 
+    /**
+     * Listening port number of the service provided
+     *
+     *  @serialField portNumb
+     */
     private static final int portNumb = 33007;
     public static int waitConnection;
 
-    public static void main (String [] args)
-    {
+    /**
+     *  Main program.
+     */
+    public static void main (String [] args) {
+
         ServiceProviderProxy serviceProviderProxy;
         DepartureQuayProxy departureQuayProxy;
         DepartureQuay departureQuay;
         ServerCom scon, sconi;
 
         // Start service
-
         scon = new ServerCom(portNumb);
         scon.start ();
         departureQuay = new DepartureQuay(new RepositoryStub("localhost", 33001));
         System.out.println ("O serviço foi estabelecido!");
         System.out.println ("O servidor esta em escuta.");
 
         // Process requests
-
         waitConnection = 0;
         while (waitConnection!=3)
             try
@@ -44,5 +50,4 @@ public static void main (String [] args)
         scon.end ();
         System.out.println ("O servidor foi desactivado.");
     }
-
 }
diff --git a/src/main/DepartureTerminalEntranceServer.java b/src/main/DepartureTerminalEntranceServer.java
@@ -12,26 +12,32 @@
 
 public class DepartureTerminalEntranceServer {
 
+    /**
+     * Listening port number of the service provided
+     *
+     *  @serialField portNumb
+     */
     private static final int portNumb = 33008;
     public static int waitConnection;
 
-    public static void main (String [] args)
-    {
+    /**
+     *  Main program.
+     */
+    public static void main (String [] args){
+
         ServiceProviderProxy serviceProviderProxy;
         DepartureTerminalEntranceProxy departureTerminalEntranceProxy;
         DepartureTerminalEntrance departureTerminalEntrance;
         ServerCom scon, sconi;
 
         // Start service
-
         scon = new ServerCom(portNumb);
         scon.start ();
         departureTerminalEntrance = new DepartureTerminalEntrance(new RepositoryStub("localhost", 33001),new ArrivalLoungeStub("localhost", 33002), new ArrivalTerminalExitStub("localhost", 33004));
         System.out.println ("O serviço foi estabelecido!");
         System.out.println ("O servidor esta em escuta.");
 
         // Process requests
-
         waitConnection = 0;
         while (waitConnection!=3)
             try
@@ -40,11 +46,8 @@ public static void main (String [] args)
                 serviceProviderProxy= new ServiceProviderProxy( departureTerminalEntranceProxy,sconi);
                 serviceProviderProxy.start ();
             }
-            catch (SocketTimeoutException e)
-            {
-            }
+            catch (SocketTimeoutException ignored) {}
         scon.end ();
         System.out.println ("O servidor foi desactivado.");
     }
-
 }