Last change
on this file since 1318 was
927,
checked in by sherbold, 12 years ago
|
- added copyright under the Apache License, Version 2.0
|
File size:
1.3 KB
|
Rev | Line | |
---|
[927] | 1 | // Copyright 2012 Georg-August-Universität Göttingen, Germany
|
---|
| 2 | //
|
---|
| 3 | // Licensed under the Apache License, Version 2.0 (the "License");
|
---|
| 4 | // you may not use this file except in compliance with the License.
|
---|
| 5 | // You may obtain a copy of the License at
|
---|
| 6 | //
|
---|
| 7 | // http://www.apache.org/licenses/LICENSE-2.0
|
---|
| 8 | //
|
---|
| 9 | // Unless required by applicable law or agreed to in writing, software
|
---|
| 10 | // distributed under the License is distributed on an "AS IS" BASIS,
|
---|
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
| 12 | // See the License for the specific language governing permissions and
|
---|
| 13 | // limitations under the License.
|
---|
| 14 |
|
---|
[1] | 15 | package de.ugoe.cs.util.console;
|
---|
| 16 |
|
---|
| 17 | import java.util.List;
|
---|
| 18 |
|
---|
| 19 | /**
|
---|
| 20 | * <p>
|
---|
| 21 | * Defines the interface for a command. The class names of the commands must be
|
---|
| 22 | * of the form {@code CMD<commandname>}, otherwise they cannot be used by the
|
---|
| 23 | * {@link CommandExecuter}.
|
---|
| 24 | * </p>
|
---|
| 25 | *
|
---|
| 26 | * @author Steffen Herbold
|
---|
[175] | 27 | * @version 1.0
|
---|
[1] | 28 | */
|
---|
| 29 | public interface Command {
|
---|
| 30 |
|
---|
| 31 | /**
|
---|
| 32 | * <p>
|
---|
| 33 | * Executes a command.
|
---|
| 34 | * </p>
|
---|
| 35 | *
|
---|
| 36 | * @param parameters
|
---|
| 37 | * parameters for the command.
|
---|
| 38 | */
|
---|
| 39 | public void run(List<Object> parameters);
|
---|
| 40 |
|
---|
| 41 | /**
|
---|
| 42 | * <p>
|
---|
[664] | 43 | * Returns a string the contains information about how to use the command.
|
---|
[1] | 44 | * </p>
|
---|
[664] | 45 | * @return help string
|
---|
[1] | 46 | */
|
---|
[664] | 47 | public String help();
|
---|
[1] | 48 | }
|
---|
Note: See
TracBrowser
for help on using the repository browser.