com.meltmedia.cadmium.cli.CliCommand Maven / Gradle / Ivy

Go to download
/**
 *    Copyright 2012 meltmedia
 *
 *    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 com.meltmedia.cadmium.cli;

/**
 * The interface to implements in order to be discovered by the {@link CadmiumCli.wireCommands} method.
 *  
 * @author John McEntire
 *
 */
public interface CliCommand {
  
  /**
   * @return The command name to use to invoke the command that implements this interface.
   */
  public String getCommandName();
  
  /**
   * Called to do the work of the implemented command.
   * 
   * @throws Exception
   */
  public void execute() throws Exception;
}