1 /**
2 * Copyright 2012 meltmedia
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package com.meltmedia.cadmium.cli;
17
18 /**
19 * The interface to implements in order to be discovered by the {@link CadmiumCli.wireCommands} method.
20 *
21 * @author John McEntire
22 *
23 */
24 public interface CliCommand {
25
26 /**
27 * @return The command name to use to invoke the command that implements this interface.
28 */
29 public String getCommandName();
30
31 /**
32 * Called to do the work of the implemented command.
33 *
34 * @throws Exception
35 */
36 public void execute() throws Exception;
37 }