src/com/googlecode/lanterna/terminal/TerminalFactory.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 java.io.IOException;
  22
  23 /**
  24  * This interface is for abstracting the creation of your Terminal object. The bundled implementation is
  25  * DefaultTerminalFactory, which will use a simple auto-detection mechanism for figuring out which terminal
  26  * implementation to create based on characteristics of the system the program is running on.
  27  * <p>
  28  * @author martin
  29  */
  30 @SuppressWarnings("WeakerAccess")
  31 public interface TerminalFactory {
  32     /**
  33      * Instantiates a Terminal according to the factory implementation.
  34      * @return Terminal implementation
  35      * @throws IOException If there was an I/O error with the underlying input/output system
  36      */
  37     Terminal createTerminal() throws IOException;
  38 }