added method show() (better this way, else Contact/UserContact contain a model method)

[jcore.git] / src / org / mxchange / jcore / client / Client.java

diff --git a/src/org/mxchange/jcore/client/Client.java b/src/org/mxchange/jcore/client/Client.java
index 1d3fd1ec2d0fe3606ef16c1e1850883f81e9f861..cd5bc0eff16e512e21652c87eeed81ee3f416335 100644 (file)
--- a/src/org/mxchange/jcore/client/Client.java
+++ b/src/org/mxchange/jcore/client/Client.java
@@ -19,45 +19,48 @@ package org.mxchange.jcore.client;
 import java.io.IOException;
 import java.sql.SQLException;
 import org.mxchange.jcore.FrameworkInterface;
-import org.mxchange.jcore.contact.Contact;
+import org.mxchange.jcore.model.contact.Contact;
 
 /**
  * An interface for application clients
- *
- * @author Roland Haeder
+ * <p>
+ * @author Roland Haeder<roland@mxchange.org>
  */
 public interface Client extends FrameworkInterface {
 
        /**
-        * Shuts down the client and therefore whole application
-        * @throws java.sql.SQLException If an SQL error occurs
-        * @throws java.io.IOException If an IO error occurs
+        * Displays a "box" for the address
+        * <p>
+        * @param contact Contact to show address from
         */
-       public void doShutdown () throws SQLException, IOException;
+       public void displayAddressBox (final Contact contact);
 
        /**
-        * Displays a message to the user
-        *
-        * @param message Message to show to the user
+        * Displays a "box" for the name
+        * <p>
+        * @param contact Contact to show name from
         */
-       public void outputMessage (final String message);
+       public void displayNameBox (final Contact contact);
 
        /**
-        * Enables isRunning attribute which singals that the client is running
+        * Displays a "box" for other data
+        * <p>
+        * @param contact Contact to show other data from
         */
-       public void enableIsRunning ();
+       public void displayOtherDataBox (final Contact contact);
 
        /**
-        * Determines whether the client is still active by checking some conditions
-        *
-        * @return Whether the client is still active
+        * Shuts down the client and therefore whole application
+        * <p>
+        * @throws java.io.IOException If an IO error occurs
+        * @throws java.sql.SQLException If a SQL error occurs
         */
-       public boolean isRunning ();
+       public void doShutdown () throws IOException, SQLException;
 
        /**
-        * Shows introduction to user
+        * Enables isRunning attribute which singals that the client is running
         */
-       public void showWelcome ();
+       public void enableIsRunning ();
 
        /**
         * Inizializes this client
@@ -65,23 +68,28 @@ public interface Client extends FrameworkInterface {
        public void init ();
 
        /**
-        * Displays a "box" for the address
-        *
-        * @param contact Contact to show address from
+        * Determines whether the client is still active by checking some conditions
+        * <p>
+        * @return Whether the client is still active
         */
-       public void displayAddressBox (final Contact contact);
+       public boolean isRunning ();
 
        /**
-        * Displays a "box" for the name
-        *
-        * @param contact Contact to show name from
+        * Displays a message to the user
+        * <p>
+        * @param message Message to show to the user
         */
-       public void displayNameBox (final Contact contact);
+       public void outputMessage (final String message);
 
        /**
-        * Displays a "box" for other data
+        * Shows given contact instamce
         *
-        * @param contact Contact to show other data from
+        * @param contact Contact instance
         */
-       public void displayOtherDataBox (final Contact contact);
+       public void show (final Contact contact);
+
+       /**
+        * Shows introduction to user
+        */
+       public void showWelcome ();
 }