org.crsh.shell.Shell Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of crash.shell Show documentation

The Shell module

The newest version!

/*
 * Copyright (C) 2012 eXo Platform SAS.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.crsh.shell;

import org.crsh.cli.impl.completion.CompletionMatch;

import java.io.Closeable;

public interface Shell extends Closeable {

  /**
   * Returns the welcome message.
   *
   * @return the welcome message
   */
  String getWelcome();

  /**
   * Returns the shell prompt.
   *
   * @return the shell prompt
   */
  String getPrompt();

  /**
   * Process a request.
   *
   * @param request the request to process
   * @return the process
   * @throws IllegalStateException if the shell cannot create a process
   */
  ShellProcess createProcess(String request) throws IllegalStateException;

  /**
   * Completion.
   *
   *
   * @param prefix the prefix to complete
   * @return the sorted list of available suffixes
   */
  CompletionMatch complete(String prefix);

}