Package com.powsybl.tools
Interface Command
-
public interface Command
- Author:
- Geoffroy Jamgotchian
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description String
getDescription()
Get a description of the command.String
getName()
Get the name of the command.org.apache.commons.cli.Options
getOptions()
Get the command options.String
getTheme()
Get the command theme used to group in the help usage commands with the same theme.String
getUsageFooter()
Get a foot text that will be displayed in the command usage.default boolean
isHidden()
Check if the command must be visible in the help.
-
-
-
Method Detail
-
getName
String getName()
Get the name of the command.- Returns:
- the name of the command
-
getTheme
String getTheme()
Get the command theme used to group in the help usage commands with the same theme.- Returns:
- the command theme
-
getDescription
String getDescription()
Get a description of the command.- Returns:
- a description of the command
-
getOptions
org.apache.commons.cli.Options getOptions()
Get the command options.- Returns:
- the command options
-
getUsageFooter
String getUsageFooter()
Get a foot text that will be displayed in the command usage.- Returns:
- a usage foot text
-
isHidden
default boolean isHidden()
Check if the command must be visible in the help.- Returns:
- true if the command has to be hidden, false otherwise
-
-