Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- AbstractVersion - Class in com.powsybl.tools
- AbstractVersion(String, String, String, String, long) - Constructor for class com.powsybl.tools.AbstractVersion
- add(OptionTypeMapper.Key, OptionType) - Method in class com.powsybl.tools.autocompletion.OptionTypeMapper
- addArgNameMapping(String, OptionType) - Method in class com.powsybl.tools.autocompletion.OptionTypeMapper
-
Maps a regex on the argument name to a specific type
- addOption(BashOption) - Method in class com.powsybl.tools.autocompletion.BashCommand
- addOptionNameMapping(String, OptionType) - Method in class com.powsybl.tools.autocompletion.OptionTypeMapper
-
Maps a regex on the option name to a specific type
B
- BashCommand - Class in com.powsybl.tools.autocompletion
-
Simplified command model for completion script generation.
- BashCommand(String) - Constructor for class com.powsybl.tools.autocompletion.BashCommand
- BashCommand(String, BashOption...) - Constructor for class com.powsybl.tools.autocompletion.BashCommand
- BashCommand(String, List<BashOption>) - Constructor for class com.powsybl.tools.autocompletion.BashCommand
- BashCompletionGenerator - Interface in com.powsybl.tools.autocompletion
- BashCompletionTool - Class in com.powsybl.tools.autocompletion
- BashCompletionTool() - Constructor for class com.powsybl.tools.autocompletion.BashCompletionTool
- BashOption - Class in com.powsybl.tools.autocompletion
-
Simplified option model for completion script generation.
- BashOption(String) - Constructor for class com.powsybl.tools.autocompletion.BashOption
- BashOption(String, String) - Constructor for class com.powsybl.tools.autocompletion.BashOption
- BashOption(String, String, OptionType) - Constructor for class com.powsybl.tools.autocompletion.BashOption
- buildTimestamp - Variable in class com.powsybl.tools.AbstractVersion
C
- com.powsybl.tools - module com.powsybl.tools
- com.powsybl.tools - package com.powsybl.tools
- com.powsybl.tools.autocompletion - package com.powsybl.tools.autocompletion
-
Utilities to generate a shell autocompletion files for itools commands.
- Command - Interface in com.powsybl.tools
- COMMAND_NOT_FOUND_STATUS - Static variable in class com.powsybl.tools.CommandLineTools
- COMMAND_OK_STATUS - Static variable in class com.powsybl.tools.CommandLineTools
- CommandLineTools - Class in com.powsybl.tools
- CommandLineTools() - Constructor for class com.powsybl.tools.CommandLineTools
- CommandLineTools(Iterable<Tool>) - Constructor for class com.powsybl.tools.CommandLineTools
- CommandLineUtil - Class in com.powsybl.tools
- convert(Map<String, Options>) - Static method in class com.powsybl.tools.autocompletion.BashCommand
- convert(Options) - Static method in class com.powsybl.tools.autocompletion.BashOption
- createLongTimeExecutionComputationManager(CommandLine) - Method in interface com.powsybl.tools.ToolInitializationContext
- createShortTimeExecutionComputationManager(CommandLine) - Method in interface com.powsybl.tools.ToolInitializationContext
D
- DIRECTORY - Enum constant in enum class com.powsybl.tools.autocompletion.OptionType.Kind
- DIRECTORY - Static variable in interface com.powsybl.tools.autocompletion.OptionType
E
- enumeration(Class<? extends Enum<?>>) - Static method in interface com.powsybl.tools.autocompletion.OptionType
- Enumeration(Class<? extends Enum<?>>) - Constructor for class com.powsybl.tools.autocompletion.OptionType.Enumeration
- ENUMERATION - Enum constant in enum class com.powsybl.tools.autocompletion.OptionType.Kind
- equals(Object) - Method in class com.powsybl.tools.autocompletion.OptionTypeMapper.Key
- EXECUTION_ERROR_STATUS - Static variable in class com.powsybl.tools.CommandLineTools
F
- FILE - Enum constant in enum class com.powsybl.tools.autocompletion.OptionType.Kind
- FILE - Static variable in interface com.powsybl.tools.autocompletion.OptionType
G
- generateCommands(String, List<BashCommand>, Writer) - Method in interface com.powsybl.tools.autocompletion.BashCompletionGenerator
- generateCommands(String, List<BashCommand>, Writer) - Method in class com.powsybl.tools.autocompletion.StringTemplateBashCompletionGenerator
- generateCompletionScript(List<Tool>, Path) - Method in class com.powsybl.tools.autocompletion.BashCompletionTool
- getAdditionalOptions() - Method in interface com.powsybl.tools.ToolInitializationContext
- getArgName() - Method in class com.powsybl.tools.autocompletion.BashOption
- getBuildTimestamp() - Method in class com.powsybl.tools.AbstractVersion
- getBuildTimestamp() - Method in interface com.powsybl.tools.Version
- getClazz() - Method in class com.powsybl.tools.autocompletion.OptionType.Enumeration
- getCommand() - Method in class com.powsybl.tools.autocompletion.BashCompletionTool
- getCommand() - Method in class com.powsybl.tools.PluginsInfoTool
- getCommand() - Method in interface com.powsybl.tools.Tool
-
Get the command of the tool.
- getCommand() - Method in class com.powsybl.tools.VersionTool
- getDescription() - Method in interface com.powsybl.tools.Command
-
Get a description of the command.
- getDouble(String) - Method in class com.powsybl.tools.ToolOptions
-
If exists, return the option value as a double.
- getEnum(String, Class<E>) - Method in class com.powsybl.tools.ToolOptions
-
If exists, return the option value as an enum.
- getErrorStream() - Method in interface com.powsybl.tools.ToolInitializationContext
- getErrorStream() - Method in class com.powsybl.tools.ToolRunningContext
- getFileSystem() - Method in interface com.powsybl.tools.ToolInitializationContext
- getFileSystem() - Method in class com.powsybl.tools.ToolRunningContext
- getFloat(String) - Method in class com.powsybl.tools.ToolOptions
-
If exists, return the option value as a float.
- getGitBranch() - Method in class com.powsybl.tools.AbstractVersion
- getGitBranch() - Method in interface com.powsybl.tools.Version
- getGitVersion() - Method in class com.powsybl.tools.AbstractVersion
- getGitVersion() - Method in interface com.powsybl.tools.Version
- getInt(String) - Method in class com.powsybl.tools.ToolOptions
-
If exists, return the option value as an int.
- getKind() - Method in enum class com.powsybl.tools.autocompletion.OptionType.Directory
- getKind() - Method in class com.powsybl.tools.autocompletion.OptionType.Enumeration
- getKind() - Method in enum class com.powsybl.tools.autocompletion.OptionType.File
- getKind() - Method in interface com.powsybl.tools.autocompletion.OptionType
- getKind() - Method in enum class com.powsybl.tools.autocompletion.OptionType.Hostname
- getLongTimeExecutionComputationManager() - Method in class com.powsybl.tools.ToolRunningContext
- getMavenProjectVersion() - Method in class com.powsybl.tools.AbstractVersion
- getMavenProjectVersion() - Method in interface com.powsybl.tools.Version
- getName() - Method in class com.powsybl.tools.autocompletion.BashCommand
- getName() - Method in class com.powsybl.tools.autocompletion.BashOption
-
Full option name, including the "-" or "--" prefix
- getName() - Method in interface com.powsybl.tools.Command
-
Get the name of the command.
- getOptions() - Method in class com.powsybl.tools.autocompletion.BashCommand
- getOptions() - Method in interface com.powsybl.tools.Command
-
Get the command options.
- getOptionValue(CommandLine, String, Class<T>, T) - Static method in class com.powsybl.tools.CommandLineUtil
- getOutputStream() - Method in interface com.powsybl.tools.ToolInitializationContext
- getOutputStream() - Method in class com.powsybl.tools.ToolRunningContext
- getPath(String) - Method in class com.powsybl.tools.ToolOptions
-
If exists, return the option value as a file system
Path
. - getPossibleValues() - Method in class com.powsybl.tools.autocompletion.BashOption
- getRegex() - Method in class com.powsybl.tools.autocompletion.OptionTypeMapper.Key
- getRepositoryName() - Method in class com.powsybl.tools.AbstractVersion
- getRepositoryName() - Method in interface com.powsybl.tools.Version
- getShortTimeExecutionComputationManager() - Method in class com.powsybl.tools.ToolRunningContext
- getTableString() - Static method in interface com.powsybl.tools.Version
- getTableString(PlatformConfig) - Static method in interface com.powsybl.tools.Version
- getTheme() - Method in interface com.powsybl.tools.Command
-
Get the command theme used to group in the help usage commands with the same theme.
- getType() - Method in class com.powsybl.tools.autocompletion.BashOption
- getType() - Method in class com.powsybl.tools.autocompletion.OptionTypeMapper.Key
- getUsageFooter() - Method in interface com.powsybl.tools.Command
-
Get a foot text that will be displayed in the command usage.
- getValue(String) - Method in class com.powsybl.tools.ToolOptions
-
If exists, return the option value as a string.
- getValue(String, Function<String, T>) - Method in class com.powsybl.tools.ToolOptions
-
If exists, return the option value parsed with the provided parser.
- getValues(String) - Method in class com.powsybl.tools.ToolOptions
-
If exists, return the option value as a list of strings, assuming they were provided as a comma separated list.
- gitBranch - Variable in class com.powsybl.tools.AbstractVersion
- gitVersion - Variable in class com.powsybl.tools.AbstractVersion
H
- hasArg() - Method in class com.powsybl.tools.autocompletion.BashOption
- hashCode() - Method in class com.powsybl.tools.autocompletion.OptionTypeMapper.Key
- hasOption(String) - Method in class com.powsybl.tools.ToolOptions
-
Return true if the option is defined.
- HOSTNAME - Enum constant in enum class com.powsybl.tools.autocompletion.OptionType.Kind
- HOSTNAME - Static variable in interface com.powsybl.tools.autocompletion.OptionType
I
- INSTANCE - Enum constant in enum class com.powsybl.tools.autocompletion.OptionType.Directory
- INSTANCE - Enum constant in enum class com.powsybl.tools.autocompletion.OptionType.File
- INSTANCE - Enum constant in enum class com.powsybl.tools.autocompletion.OptionType.Hostname
- INVALID_COMMAND_STATUS - Static variable in class com.powsybl.tools.CommandLineTools
- isDir() - Method in class com.powsybl.tools.autocompletion.BashOption
- isEnum() - Method in class com.powsybl.tools.autocompletion.BashOption
- isFile() - Method in class com.powsybl.tools.autocompletion.BashOption
- isHidden() - Method in interface com.powsybl.tools.Command
-
Check if the command must be visible in the help.
- isHostname() - Method in class com.powsybl.tools.autocompletion.BashOption
K
- Key(String, OptionTypeMapper.Key.Type) - Constructor for class com.powsybl.tools.autocompletion.OptionTypeMapper.Key
L
M
- main(String[]) - Static method in class com.powsybl.tools.Main
- Main - Class in com.powsybl.tools
- map(BashCommand) - Method in class com.powsybl.tools.autocompletion.OptionTypeMapper
- map(BashOption) - Method in class com.powsybl.tools.autocompletion.OptionTypeMapper
- map(List<BashCommand>) - Method in class com.powsybl.tools.autocompletion.OptionTypeMapper
- mavenProjectVersion - Variable in class com.powsybl.tools.AbstractVersion
O
- OPTION_ARG_NAME - Enum constant in enum class com.powsybl.tools.autocompletion.OptionTypeMapper.Key.Type
- OPTION_NAME - Enum constant in enum class com.powsybl.tools.autocompletion.OptionTypeMapper.Key.Type
- OptionType - Interface in com.powsybl.tools.autocompletion
- OptionType.Directory - Enum Class in com.powsybl.tools.autocompletion
- OptionType.Enumeration - Class in com.powsybl.tools.autocompletion
- OptionType.File - Enum Class in com.powsybl.tools.autocompletion
- OptionType.Hostname - Enum Class in com.powsybl.tools.autocompletion
- OptionType.Kind - Enum Class in com.powsybl.tools.autocompletion
- OptionTypeMapper - Class in com.powsybl.tools.autocompletion
-
Tries to guess option argument type, to guide autocompletion.
- OptionTypeMapper() - Constructor for class com.powsybl.tools.autocompletion.OptionTypeMapper
- OptionTypeMapper.Key - Class in com.powsybl.tools.autocompletion
- OptionTypeMapper.Key.Type - Enum Class in com.powsybl.tools.autocompletion
P
- PluginsInfoTool - Class in com.powsybl.tools
- PluginsInfoTool() - Constructor for class com.powsybl.tools.PluginsInfoTool
- PowsyblCoreVersion - Class in com.powsybl.tools
- PowsyblCoreVersion() - Constructor for class com.powsybl.tools.PowsyblCoreVersion
- printCommandUsage(String, Options, String, PrintStream) - Static method in class com.powsybl.tools.CommandLineTools
R
- repositoryName - Variable in class com.powsybl.tools.AbstractVersion
- run(String[], ToolInitializationContext) - Method in class com.powsybl.tools.CommandLineTools
- run(CommandLine, ToolRunningContext) - Method in class com.powsybl.tools.autocompletion.BashCompletionTool
- run(CommandLine, ToolRunningContext) - Method in class com.powsybl.tools.PluginsInfoTool
- run(CommandLine, ToolRunningContext) - Method in interface com.powsybl.tools.Tool
-
Run the tool.
- run(CommandLine, ToolRunningContext) - Method in class com.powsybl.tools.VersionTool
S
- setDefaultType(OptionType) - Method in class com.powsybl.tools.autocompletion.OptionTypeMapper
-
Sets the type to be used as a fallback
- setType(OptionType) - Method in class com.powsybl.tools.autocompletion.BashOption
- StringTemplateBashCompletionGenerator - Class in com.powsybl.tools.autocompletion
-
Generator based on stringtemplate lib
- StringTemplateBashCompletionGenerator() - Constructor for class com.powsybl.tools.autocompletion.StringTemplateBashCompletionGenerator
T
- TASK - Static variable in class com.powsybl.tools.ToolConstants
- TASK_COUNT - Static variable in class com.powsybl.tools.ToolConstants
- toMap() - Method in class com.powsybl.tools.AbstractVersion
- Tool - Interface in com.powsybl.tools
- ToolConstants - Class in com.powsybl.tools
- ToolInitializationContext - Interface in com.powsybl.tools
- ToolOptions - Class in com.powsybl.tools
-
Wrapper around
CommandLine
to provide a more user friendly syntax, in particular based onOptional
s. - ToolOptions(CommandLine, ToolRunningContext) - Constructor for class com.powsybl.tools.ToolOptions
- ToolOptions(CommandLine, FileSystem) - Constructor for class com.powsybl.tools.ToolOptions
- ToolRunningContext - Class in com.powsybl.tools
- ToolRunningContext(PrintStream, PrintStream, FileSystem, ComputationManager, ComputationManager) - Constructor for class com.powsybl.tools.ToolRunningContext
- toString() - Method in class com.powsybl.tools.AbstractVersion
V
- valueOf(String) - Static method in enum class com.powsybl.tools.autocompletion.OptionType.Directory
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.powsybl.tools.autocompletion.OptionType.File
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.powsybl.tools.autocompletion.OptionType.Hostname
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.powsybl.tools.autocompletion.OptionType.Kind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.powsybl.tools.autocompletion.OptionTypeMapper.Key.Type
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.powsybl.tools.autocompletion.OptionType.Directory
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.powsybl.tools.autocompletion.OptionType.File
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.powsybl.tools.autocompletion.OptionType.Hostname
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.powsybl.tools.autocompletion.OptionType.Kind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.powsybl.tools.autocompletion.OptionTypeMapper.Key.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- Version - Interface in com.powsybl.tools
- VersionTool - Class in com.powsybl.tools
- VersionTool() - Constructor for class com.powsybl.tools.VersionTool
- VersionTool(PlatformConfig) - Constructor for class com.powsybl.tools.VersionTool
All Classes and Interfaces|All Packages|Constant Field Values