src/com/googlecode/lanterna/terminal/IOSafeTerminal.java

   1 /*
   2  * This file is part of lanterna (http://code.google.com/p/lanterna/).
   3  *
   4  * lanterna is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  *
  17  * Copyright (C) 2010-2015 Martin
  18  */
  19 package com.googlecode.lanterna.terminal;
  20
  21 import com.googlecode.lanterna.SGR;
  22 import com.googlecode.lanterna.TerminalSize;
  23 import com.googlecode.lanterna.TextColor;
  24 import com.googlecode.lanterna.input.KeyStroke;
  25
  26 import java.io.IOException;
  27 import java.util.concurrent.TimeUnit;
  28
  29 /**
  30  * Interface extending Terminal that removes the IOException throw clause. You can for example use this instead of
  31  * Terminal if you use an implementation that doesn't throw any IOExceptions or if you wrap your terminal in an
  32  * IOSafeTerminalAdapter. Please note that readInput() still throws IOException when it is interrupted, in order to fit
  33  * better in with what normal terminal do when they are blocked on input and you interrupt them.
  34  * @author Martin
  35  */
  36 public interface IOSafeTerminal extends Terminal {
  37     @Override
  38     void enterPrivateMode();
  39     @Override
  40     void exitPrivateMode();
  41     @Override
  42     void clearScreen();
  43     @Override
  44     void setCursorPosition(int x, int y);
  45     @Override
  46     void setCursorVisible(boolean visible);
  47     @Override
  48     void putCharacter(char c);
  49     @Override
  50     void enableSGR(SGR sgr);
  51     @Override
  52     void disableSGR(SGR sgr);
  53     @Override
  54     void resetColorAndSGR();
  55     @Override
  56     void setForegroundColor(TextColor color);
  57     @Override
  58     void setBackgroundColor(TextColor color);
  59     @Override
  60     TerminalSize getTerminalSize();
  61     @Override
  62     byte[] enquireTerminal(int timeout, TimeUnit timeoutUnit);
  63     @Override
  64     void flush();
  65     @Override
  66     KeyStroke pollInput();
  67     @Override
  68     KeyStroke readInput() throws IOException;
  69 }