Class Command

    • Field Detail

      • GENERAL_CONFIGURATION_ERROR

        public static int GENERAL_CONFIGURATION_ERROR
        General configuration error exit code.
      • INPUT_DATA_NOT_CONFIRMED

        public static int INPUT_DATA_NOT_CONFIRMED
      • status

        private int status
      • redirectionValues

        private List<String> redirectionValues
      • enableDebug

        private boolean enableDebug
      • toolCommand

        private String toolCommand
        Command used to execute the tool.
      • WIDTH

        public static int WIDTH
        Default help line width.
    • Constructor Detail

      • Command

        public Command()
    • Method Detail

      • help

        public void help()
        Display help to the command.
      • isAlias

        public boolean isAlias​(String alias)
      • getStatus

        public int getStatus()
      • setStatus

        protected void setStatus​(int status)
      • isWindows

        public static boolean isWindows()
      • prompt

        protected String prompt​(boolean echo,
                                String prompt,
                                boolean confirm,
                                String confirmPrompt)
                         throws Exception
        Prompt for interactive user input with possible confirmation of input data. When data are not confirmed tool exits with INPUT_DATA_NOT_CONFIRMED exit code
        Parameters:
        echo - echo the characters typed
        prompt - text to display before the input
        confirm - confirm data after the first input
        confirmPrompt - confirmation text
        Returns:
        data as user inputs it
        Throws:
        Exception
      • printDuplicatesWarning

        public void printDuplicatesWarning​(org.apache.commons.cli.CommandLine cmdLine)
        Alerts if any of the command line options used are duplicated
        Parameters:
        cmdLine - the command line options used when invoking the command, after parsing
      • printDuplicatesWarning

        public void printDuplicatesWarning​(org.apache.commons.cli.CommandLine cmdLine,
                                           List<String> duplicatesAllowed)
        Alerts if any of the command line options used are duplicated, excluding commands that are allowed to have duplicates
        Parameters:
        cmdLine - the command line options used when invoking the command, after parsing
        duplicatesAllowed - list of the commands line options that can be duplicated. For example: List allowedDuplicates = new ArrayList() {{ add(PASSWORD_CREDENTIAL_VALUE_PARAM); }};
      • isEnableDebug

        public boolean isEnableDebug()
        Get the command debug option
      • setEnableDebug

        public void setEnableDebug​(boolean enableDebug)
        Set the command debug option
      • getToolCommand

        public String getToolCommand()
        Get tool command
      • setToolCommand

        public void setToolCommand​(String toolCommand)
        Set tool command