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