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.command;
021    
022    import org.crsh.SessionContext;
023    import org.crsh.cmdline.CommandCompletion;
024    
025    import java.util.List;
026    import java.util.Map;
027    
028    /**
029     * A shell command.
030     */
031    public interface ShellCommand {
032    
033      /**
034       * Provide completions for the specified arguments.
035       *
036       * @param context the command context
037       * @param line the original command line arguments
038       * @return the completions
039       */
040      CommandCompletion complete(SessionContext context, String line);
041    
042      /**
043       * Returns a description of the command or null if none can be found.
044       *
045       * @param line the usage line
046       * @param mode the description mode
047       * @return the description
048       */
049      String describe(String line, DescriptionFormat mode);
050    
051      /**
052       * Provides an invoker for the command line specified as a command line to parse.
053       *
054       * @param line the command line arguments
055       * @return the command
056       */
057      CommandInvoker<?, ?> resolveInvoker(String line);
058    
059      /**
060       * Provides an invoker for the command line specified under the form of a command, options and arguments.
061       *
062       * @param name the command name, might be null
063       * @param options the options
064       * @param args the arguments
065       * @return the command
066       */
067      CommandInvoker<?, ?> resolveInvoker(String name, Map<String, ?> options, List<?> args);
068    
069    }