12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273 |
- /*
- * Copyright (c) 2006-2011 Chris Smith, Shane Mc Cormack, Gregory Holmes
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
- package com.dmdirc.commandparser;
-
- /**
- * Describes a command.
- *
- * @author chris
- */
- public interface CommandInfo {
-
- /**
- * Returns this command's name.
- *
- * @return The name of this command
- */
- String getName();
-
- /**
- * Returns whether or not this command should be shown in help messages.
- *
- * @return True iff the command should be shown, false otherwise
- */
- boolean showInHelp();
-
- /**
- * Returns a string representing the help message for this command.
- * <p>
- * The help text should generally be one line, and must start with
- * the name of the command. It should then summarise the arguments of
- * that command, using <code><angled></code> brackets for required
- * arguments, and <code>[square]</code> brackets for optional arguments.
- * Where multiple possibilities exist, they are typically separated by a
- * pipe (<code>|</code>), for example: <code>command [--arg1|--arg2]</code>.
- * The usage summary should then be followed by a dash and a brief
- * summary of the purpose of the command.
- * <p>
- * A typical help message would look similar to:
- * <p>
- * <code>command [--arg <param_for_arg>] [someparam] - does x, y and z</code>
- *
- * @return the help message for this command
- */
- String getHelp();
-
- /**
- * Retrieves the type of this command.
- *
- * @return This command's type
- */
- CommandType getType();
-
- }
|