groovy-core/src/main/org/codehaus/groovy/tools/shell/Command.groovy

/*
 * Copyright 2003-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.codehaus.groovy.tools.shell

import jline.Completor

/**
 * Provides the interface required for command extentions.
 *
 * @version $Id$
 * @author <a href="mailto:jason@planet57.com">Jason Dillon</a>
 */
interface Command
{
    String getName()

    String getShortcut()

    Completor getCompletor()

    String getDescription()

    String getUsage()

    String getHelp()

    List<CommandAlias> getAliases()

    Object execute(List args)
    
    boolean getHidden()
}

/**
 * Thrown to indicate a problem with command execution.
 *
 * @version $Id$
 * @author <a href="mailto:jason@planet57.com">Jason Dillon</a>
 */
class CommandException
    extends Exception
{
    final Command command
    
    CommandException(final Command command, final String msg) {
        super(msg)
        
        assert command
        
        this.command = command
    }
    
    CommandException(final Command command, final String msg, final Throwable cause) {
        super(msg, cause)
        
        assert command
        
        this.command = command
    }
}