src/jexer/backend/SessionInfo.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * The MIT License (MIT)
   5  *
   6  * Copyright (C) 2019 Kevin Lamonte
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the "Software"),
  10  * to deal in the Software without restriction, including without limitation
  11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12  * and/or sell copies of the Software, and to permit persons to whom the
  13  * Software is furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24  * DEALINGS IN THE SOFTWARE.
  25  *
  26  * @author Kevin Lamonte [kevin.lamonte@gmail.com]
  27  * @version 1
  28  */
  29 package jexer.backend;
  30
  31 /**
  32  * SessionInfo is used to store per-session properties that are determined at
  33  * different layers of the communication stack.
  34  */
  35 public interface SessionInfo {
  36
  37     /**
  38      * Username getter.
  39      *
  40      * @return the username
  41      */
  42     public String getUsername();
  43
  44     /**
  45      * Username setter.
  46      *
  47      * @param username the value
  48      */
  49     public void setUsername(String username);
  50
  51     /**
  52      * Language getter.
  53      *
  54      * @return the language
  55      */
  56     public String getLanguage();
  57
  58     /**
  59      * Language setter.
  60      *
  61      * @param language the value
  62      */
  63     public void setLanguage(String language);
  64
  65     /**
  66      * Text window width getter.
  67      *
  68      * @return the window width
  69      */
  70     public int getWindowWidth();
  71
  72     /**
  73      * Text window height getter.
  74      *
  75      * @return the window height
  76      */
  77     public int getWindowHeight();
  78
  79     /**
  80      * Re-query the text window size.
  81      */
  82     public void queryWindowSize();
  83 }