home | career | drupal | java | mac | mysql | perl | scala | uml | unix

Groovy example source code file (Command.groovy)

This example Groovy source code file (Command.groovy) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Groovy tags/keywords

command, command, commandexception, commandexception, completor, exception, list/*, list/*, object, string, string, throwable

The Groovy Command.groovy source code

/*
 * 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 extensions.
 *
 * @version $Id: Command.groovy 21140 2010-11-28 19:50:55Z hamletdrc $
 * @author <a href="mailto:jason@planet57.com">Jason Dillon
 */
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: Command.groovy 21140 2010-11-28 19:50:55Z hamletdrc $
 * @author <a href="mailto:jason@planet57.com">Jason Dillon
 */
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
    }
}

Other Groovy examples (source code examples)

Here is a short list of links related to this Groovy Command.groovy source code file:

new blog posts

 

Copyright 1998-2014 Alvin Alexander, alvinalexander.com
All Rights Reserved.