Interface CLIConstants


  • public interface CLIConstants
    This interface defines constants used in the package.
    • Field Detail

      • SYS_PROPERTY_DEFINITION_FILES

        static final String SYS_PROPERTY_DEFINITION_FILES
        Name of definition files that drive the behavior of CLI. These files are passed in as a property in the java interface. i.e. java -DdefinitionFiles=....
        See Also:
        Constant Field Values
      • SYS_PROPERTY_COMMAND_NAME

        static final String SYS_PROPERTY_COMMAND_NAME
        Name of the commandline interface. This name is passed in as a property in the java interface. i.e. java -DcommandName=....
        See Also:
        Constant Field Values
      • SYS_PROPERTY_OUTPUT_WRITER

        static final String SYS_PROPERTY_OUTPUT_WRITER
        Class name of the output writer. This name is passed in as a property in the java interface. i.e. java -DoutputWriter=....
        See Also:
        Constant Field Values
      • FLD_PRODUCT_NAME

        static final String FLD_PRODUCT_NAME
        Name of product name field in definition class.
        See Also:
        Constant Field Values
      • ANNOT_PRODUCTNAME

        static final String ANNOT_PRODUCTNAME
        Name of product name annotation in definition class.
        See Also:
        Constant Field Values
      • ANNOT_VERSION

        static final String ANNOT_VERSION
        Name of product version annotation in definition class.
        See Also:
        Constant Field Values
      • ANNOT_RESOURCE_BUNDLE_NAME

        static final String ANNOT_RESOURCE_BUNDLE_NAME
        Name of product resource bundle name annotation in definition class.
        See Also:
        Constant Field Values
      • PREFIX_ARGUMENT

        static final String PREFIX_ARGUMENT
        Prefix for argument/option defined in this interface.
        See Also:
        Constant Field Values
      • PREFIX_SHORT_ARGUMENT

        static final String PREFIX_SHORT_ARGUMENT
        Prefix for short argument/option defined in this interface.
        See Also:
        Constant Field Values
      • PREFIX_ARGUMENT_LONG

        static final String PREFIX_ARGUMENT_LONG
        Prefix of long argument/option passed into the CLI. e.g. --version
        See Also:
        Constant Field Values
      • PREFIX_ARGUMENT_SHORT

        static final String PREFIX_ARGUMENT_SHORT
        Prefix of short argument/option passed into the CLI. e.g. --n
        See Also:
        Constant Field Values
      • PREFIX_SUBCMD_RES

        static final String PREFIX_SUBCMD_RES
        Prefix of resource key. e.g. subcmd-version=Print Version of this tool.
        See Also:
        Constant Field Values
      • FLAG_WEB_UI_TEXTAREA

        static final String FLAG_WEB_UI_TEXTAREA
        Flag to indicate that an argument/option is to be displayed as textarea in web based CLI.
        See Also:
        Constant Field Values
      • FLAG_WEB_UI_TEXT

        static final String FLAG_WEB_UI_TEXT
        Flag to indicate that an argument/option is to be displayed as text box in web based CLI.
        See Also:
        Constant Field Values
      • FLAG_WEB_UI_CHECKBOX

        static final String FLAG_WEB_UI_CHECKBOX
        Flag to indicate that an argument/option is to be displayed as checkbox in web based CLI.
        See Also:
        Constant Field Values
      • FLAG_UNARY

        static final String FLAG_UNARY
        Flag to indicate that an argument/option is unary. e.g. --help
        See Also:
        Constant Field Values
      • FLAG_SINGLE

        static final String FLAG_SINGLE
        Flag to indicate that an argument/option is single. e.g. --locale en_US
        See Also:
        Constant Field Values
      • SHORT_ARGUMENT_VERSION

        static final String SHORT_ARGUMENT_VERSION
        Short name of version argument/option.
        See Also:
        Constant Field Values
      • ARGUMENT_INFORMATION

        static final String ARGUMENT_INFORMATION
        Name of tool information argument/option.
        See Also:
        Constant Field Values
      • SHORT_ARGUMENT_INFORMATION

        static final String SHORT_ARGUMENT_INFORMATION
        Short name of information argument/option.
        See Also:
        Constant Field Values
      • SHORT_ARGUMENT_VERBOSE

        static final String SHORT_ARGUMENT_VERBOSE
        Short name of verbose argument/option.
        See Also:
        Constant Field Values
      • SHORT_ARGUMENT_LOCALE

        static final String SHORT_ARGUMENT_LOCALE
        Short name of locale argument/option.
        See Also:
        Constant Field Values
      • SHORT_ARGUMENT_NOLOG

        static final String SHORT_ARGUMENT_NOLOG
        Short name of disable logging argument/option.
        See Also:
        Constant Field Values
      • USAGE_SUBCMD_FORMAT

        static final String USAGE_SUBCMD_FORMAT
        Template for formating sub command (short format) in usage text.
        See Also:
        Constant Field Values
      • USAGE_SUBCMD_LONG_FORMAT

        static final String USAGE_SUBCMD_LONG_FORMAT
        Template for formating sub command (long format) in usage text.
        See Also:
        Constant Field Values
      • USAGE_SUBCMD_EX_FORMAT

        static final String USAGE_SUBCMD_EX_FORMAT
        Template for formating sub command (extended format) in usage text.
        See Also:
        Constant Field Values
      • USAGE_SUBCMD_HELP_FORMAT

        static final String USAGE_SUBCMD_HELP_FORMAT
        Template for formating sub command help in usage text.
        See Also:
        Constant Field Values
      • USAGE_OPTION_NAME_FORMAT

        static final String USAGE_OPTION_NAME_FORMAT
        Template for formating mandatory option name in usage text.
        See Also:
        Constant Field Values
      • USAGE_OPTIONAL_OPTION_NAME_FORMAT

        static final String USAGE_OPTIONAL_OPTION_NAME_FORMAT
        Template for formating operational option name in usage text.
        See Also:
        Constant Field Values
      • USAGE_OPTION_FORMAT

        static final String USAGE_OPTION_FORMAT
        Template for formating mandatory option in usage text.
        See Also:
        Constant Field Values
      • USAGE_OPTION_WITH_ALIAS_FORMAT

        static final String USAGE_OPTION_WITH_ALIAS_FORMAT
        Template for formating mandatory option (with alias) in usage text.
        See Also:
        Constant Field Values
      • USAGE_OPTIONAL_OPTION_FORMAT

        static final String USAGE_OPTIONAL_OPTION_FORMAT
        Template for formating optional option in usage text.
        See Also:
        Constant Field Values
      • USAGE_OPTIONAL_OPTION_WITh_ALIAS_FORMAT

        static final String USAGE_OPTIONAL_OPTION_WITh_ALIAS_FORMAT
        Template for formating optional option (with alias) in usage text.
        See Also:
        Constant Field Values
      • ATTR_SCHEMA_AGENT_PWD

        static final String ATTR_SCHEMA_AGENT_PWD
        Agent Password Attribute Schema name
        See Also:
        Constant Field Values
      • CMD_NAME_IMPORT_SVC_CONFIG

        static final String CMD_NAME_IMPORT_SVC_CONFIG
        Import configuration data sub command name.
        See Also:
        Constant Field Values