src/org/mxchange/jcore/client/BaseClient.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.BaseFrameworkSystem;
  20
  21 /**
  22  * A general client
  23  *
  24  * @author Roland Haeder
  25  */
  26 public abstract class BaseClient extends BaseFrameworkSystem implements Client {
  27
  28         /**
  29          * Application is not running by default
  30          */
  31         private boolean isRunning;
  32
  33         /**
  34          * No instances can be created of this class
  35          */
  36         protected BaseClient () {
  37         }
  38
  39         /**
  40          * Shutdown method for all clients
  41          */
  42         @Override
  43         public void doShutdown () {
  44                 // Trace message
  45                 this.getLogger().trace("CALLED!"); //NOI18N
  46
  47                 // Disable client
  48                 this.disableIsRunning();
  49
  50                 // Shuts down contact manager
  51                 this.getManager().doShutdown();
  52
  53                 // Trace message
  54                 this.getLogger().trace("EXIT!"); //NOI18N
  55         }
  56
  57         /**
  58          * Enables the client
  59          */
  60         @Override
  61         public final void enableIsRunning () {
  62                 this.isRunning = true;
  63         }
  64
  65         /**
  66          * Determines whether the application is still active by checking some
  67          * conditions
  68          *
  69          * @return Whether the application is still active
  70          */
  71         @Override
  72         public final boolean isRunning () {
  73                 // In console client, 0 may have been used
  74                 return this.isRunning;
  75         }
  76
  77         /**
  78          * Disables the client
  79          */
  80         protected final void disableIsRunning () {
  81                 this.isRunning = false;
  82         }
  83 }