src/jexer/session/SessionInfo.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * License: LGPLv3 or later
   5  *
   6  * This module is licensed under the GNU Lesser General Public License
   7  * Version 3.  Please see the file "COPYING" in this directory for more
   8  * information about the GNU Lesser General Public License Version 3.
   9  *
  10  *     Copyright (C) 2015  Kevin Lamonte
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 3 of
  15  * the License, or (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with this program; if not, see
  24  * http://www.gnu.org/licenses/, or write to the Free Software
  25  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  26  * 02110-1301 USA
  27  *
  28  * @author Kevin Lamonte [kevin.lamonte@gmail.com]
  29  * @version 1
  30  */
  31 package jexer.session;
  32
  33 /**
  34  * SessionInfo is used to store per-session properties that are determined at
  35  * different layers of the communication stack.
  36  */
  37 public interface SessionInfo {
  38
  39     /**
  40      * Username getter.
  41      *
  42      * @return the username
  43      */
  44     public String getUsername();
  45
  46     /**
  47      * Username setter.
  48      *
  49      * @param username the value
  50      */
  51     public void setUsername(String username);
  52
  53     /**
  54      * Language getter.
  55      *
  56      * @return the language
  57      */
  58     public String getLanguage();
  59
  60     /**
  61      * Language setter.
  62      *
  63      * @param language the value
  64      */
  65     public void setLanguage(String language);
  66
  67     /**
  68      * Text window width getter.
  69      *
  70      * @return the window width
  71      */
  72     public int getWindowWidth();
  73
  74     /**
  75      * Text window height getter.
  76      *
  77      * @return the window height
  78      */
  79     public int getWindowHeight();
  80
  81     /**
  82      * Re-query the text window size.
  83      */
  84     public void queryWindowSize();
  85 }