src/org/mxchange/jcore/client/Client.java

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jcore.client;
  18
  19 import org.mxchange.jcore.FrameworkInterface;
  20
  21 /**
  22  * An interface for application clients
  23  *
  24  * @author Roland Haeder
  25  */
  26 public interface Client extends FrameworkInterface {
  27
  28         /**
  29          * Shuts down the client and therefore whole application
  30          */
  31         public void doShutdown ();
  32
  33         /**
  34          * Displays a message to the user
  35          *
  36          * @param message Message to show to the user
  37          */
  38         public void outputMessage (final String message);
  39
  40         /**
  41          * Enables isRunning attribute which singals that the client is running
  42          */
  43         public void enableIsRunning ();
  44
  45         /**
  46          * Determines whether the client is still active by checking some conditions
  47          *
  48          * @return Whether the client is still active
  49          */
  50         public boolean isRunning ();
  51
  52         /**
  53          * Shows introduction to user
  54          */
  55         public void showWelcome ();
  56
  57         /**
  58          * Inizializes this client
  59          */
  60         public void init ();
  61 }