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.shell; 021 022 import org.crsh.cli.impl.completion.CompletionMatch; 023 024 import java.io.Closeable; 025 026 public interface Shell extends Closeable { 027 028 /** 029 * Returns the welcome message. 030 * 031 * @return the welcome message 032 */ 033 String getWelcome(); 034 035 /** 036 * Returns the shell prompt. 037 * 038 * @return the shell prompt 039 */ 040 String getPrompt(); 041 042 /** 043 * Process a request. 044 * 045 * @param request the request to process 046 * @return the process 047 * @throws IllegalStateException if the shell cannot create a process 048 */ 049 ShellProcess createProcess(String request) throws IllegalStateException; 050 051 /** 052 * Completion. 053 * 054 * 055 * @param prefix the prefix to complete 056 * @return the sorted list of available suffixes 057 */ 058 CompletionMatch complete(String prefix); 059 060 }