src/org/mxchange/jcore/FrameworkInterface.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;
  18
  19 import org.apache.logging.log4j.Logger;
  20 import org.mxchange.jcore.application.Application;
  21 import org.mxchange.jcore.client.Client;
  22 import org.mxchange.jcore.manager.Manageable;
  23
  24 /**
  25  * A general interface which should be always expanded
  26  *
  27  * @author Roland Haeder
  28  */
  29 public interface FrameworkInterface {
  30         /**
  31          * File name (and path) for internalization bundle
  32          */
  33         public static final String I18N_BUNDLE_FILE = "org/mxchange/localization/bundle";
  34
  35         /**
  36          * Getter for manager
  37          *
  38          * @return Manager instance
  39          */
  40         public Manageable getManager ();
  41
  42         /**
  43          * Client instance
  44          *
  45          * @return the client
  46          */
  47         public Client getClient ();
  48
  49         /**
  50          * Getter for logger
  51          *
  52          * @return Logger
  53          */
  54         public Logger getLogger ();
  55
  56         /**
  57          * Application instance
  58          *
  59          * @return the application
  60          */
  61         public Application getApplication ();
  62
  63         /**
  64          * Getter for human-readable string from given key
  65          *
  66          * @param key Key to return
  67          * @return Human-readable message
  68          */
  69         public String getMessageStringFromKey (final String key);
  70
  71         /**
  72          * Logs given exception
  73          *
  74          * @param exception Exception to log
  75          */
  76         public void logException (final Throwable exception);
  77 }