source: trunk/JavaHelperLib/src/de/ugoe/cs/util/console/Command.java @ 319

Last change on this file since 319 was 175, checked in by sherbold, 13 years ago
  • code documentation and formatting
File size: 655 bytes
Line 
1package de.ugoe.cs.util.console;
2
3import java.util.List;
4
5/**
6 * <p>
7 * Defines the interface for a command. The class names of the commands must be
8 * of the form {@code CMD<commandname>}, otherwise they cannot be used by the
9 * {@link CommandExecuter}.
10 * </p>
11 *
12 * @author Steffen Herbold
13 * @version 1.0
14 */
15public interface Command {
16
17        /**
18         * <p>
19         * Executes a command.
20         * </p>
21         *
22         * @param parameters
23         *            parameters for the command.
24         */
25        public void run(List<Object> parameters);
26
27        /**
28         * <p>
29         * Sends information about how to use a command to the console.
30         * </p>
31         */
32        public void help();
33}
Note: See TracBrowser for help on using the repository browser.