001    /*
002     * Copyright (C) 2012 eXo Platform SAS.
003     *
004     * This is free software; you can redistribute it and/or modify it
005     * under the terms of the GNU Lesser General Public License as
006     * published by the Free Software Foundation; either version 2.1 of
007     * the License, or (at your option) any later version.
008     *
009     * This software is distributed in the hope that it will be useful,
010     * but WITHOUT ANY WARRANTY; without even the implied warranty of
011     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012     * Lesser General Public License for more details.
013     *
014     * You should have received a copy of the GNU Lesser General Public
015     * License along with this software; if not, write to the Free
016     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
017     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
018     */
019    
020    package org.crsh;
021    
022    public interface InteractionContext<E> extends Pipe<E> {
023    
024      /**
025       * Returns the term width in chars. When the value is not positive it means
026       * the value could not be determined.
027       *
028       * @return the term width
029       */
030      int getWidth();
031    
032      /**
033       * Returns the term height in chars. When the value is not positive it means
034       * the value could not be determined.
035       *
036       * @return the term height
037       */
038      int getHeight();
039    
040      /**
041       * Returns a generic property, usually this property is resolved by the
042       * shell client.
043       *
044       * @param propertyName the property name
045       * @return the property value
046       */
047      String getProperty(String propertyName);
048    
049      /**
050       * Display a message and read a line on the console. If no line can be read
051       * then null is returned.
052       *
053       * @param msg the message to display before reading a line
054       * @param echo wether or not the line read should be echoed when typing
055       * @return the line read
056       */
057      String readLine(String msg, boolean echo);
058    
059    }