CommandLineParameters (Groovy Documentation)

org.exoplatform.platform.am.cli.CommandLineParameters

Command line parameters
Authors:
Arnaud Héritier

Nested Class Summary

Nested classes
Modifiers	Name	Description
`enum`	`CommandLineParameters.Command`	The enumeration of all possible commands
`class`	`CommandLineParameters.DescribeCommandParameters`	Specific parameters to print information about an add-on
`class`	`CommandLineParameters.InstallCommandParameters`	Specific parameters to install an add-on
`class`	`CommandLineParameters.ListCommandParameters`	Specific parameters to list add-ons
`class`	`CommandLineParameters.UninstallCommandParameters`	Specific parameters to uninstall an add-on

Properties Summary

Properties
Type	Name and description
`static java.lang.String`	`BATCH_LONG_OPT`
`static java.lang.String`	`BATCH_SHORT_OPT`
`static java.lang.String`	`CATALOG_LONG_OPT`
`static java.lang.String`	`CONFLICT_LONG_OPT`
`static java.lang.String`	`DESCRIBE_CMD`
`static java.lang.String`	`FORCE_LONG_OPT`
`static java.lang.String`	`HELP_LONG_OPT`
`static java.lang.String`	`HELP_SHORT_OPT`
`static java.lang.String`	`INSTALLED_LONG_OPT`
`static java.lang.String`	`INSTALL_CMD`
`static java.lang.String`	`LIST_CMD`
`static java.lang.String`	`NO_CACHE_LONG_OPT`
`static java.lang.String`	`NO_COMPAT_LONG_OPT`
`static java.lang.String`	`OFFLINE_LONG_OPT`
`static java.lang.String`	`OUTDATED_LONG_OPT`
`static java.lang.String`	`SNAPSHOTS_LONG_OPT`
`static java.lang.String`	`UNINSTALL_CMD`
`static java.lang.String`	`UNSTABLE_LONG_OPT`
`static java.lang.String`	`VERBOSE_LONG_OPT`
`static java.lang.String`	`VERBOSE_SHORT_OPT`
`CommandLineParameters.Command`	`command` The command asked by the user
`CommandLineParameters.DescribeCommandParameters`	`commandDescribe` Describe command parameters
`CommandLineParameters.InstallCommandParameters`	`commandInstall` Install command parameters
`CommandLineParameters.ListCommandParameters`	`commandList` List command parameters
`CommandLineParameters.UninstallCommandParameters`	`commandUninstall` Uninstall command parameters

Methods Summary

Methods
Type	Name and description
`java.lang.Boolean`	`isBatchMode()` Verifies if is the batch option is activated as main parameter or command parameter
`java.lang.Boolean`	`isHelp()` Verifies if is the help option is activated as main parameter or command parameter
`java.lang.Boolean`	`isVerbose()` Verifies if is the verbose option is activated as main parameter or command parameter

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - static final java.lang.String BATCH_LONG_OPT
  - static final java.lang.String BATCH_SHORT_OPT
  - static final java.lang.String CATALOG_LONG_OPT
  - static final java.lang.String CONFLICT_LONG_OPT
  - static final java.lang.String DESCRIBE_CMD
  - static final java.lang.String FORCE_LONG_OPT
  - static final java.lang.String HELP_LONG_OPT
  - static final java.lang.String HELP_SHORT_OPT
  - static final java.lang.String INSTALLED_LONG_OPT
  - static final java.lang.String INSTALL_CMD
  - static final java.lang.String LIST_CMD
  - static final java.lang.String NO_CACHE_LONG_OPT
  - static final java.lang.String NO_COMPAT_LONG_OPT
  - static final java.lang.String OFFLINE_LONG_OPT
  - static final java.lang.String OUTDATED_LONG_OPT
  - static final java.lang.String SNAPSHOTS_LONG_OPT
  - static final java.lang.String UNINSTALL_CMD
  - static final java.lang.String UNSTABLE_LONG_OPT
  - static final java.lang.String VERBOSE_LONG_OPT
  - static final java.lang.String VERBOSE_SHORT_OPT
  - CommandLineParameters.Command command
    
    The command asked by the user
  - CommandLineParameters.DescribeCommandParameters commandDescribe
    
    Describe command parameters
  - CommandLineParameters.InstallCommandParameters commandInstall
    
    Install command parameters
  - CommandLineParameters.ListCommandParameters commandList
    
    List command parameters
  - CommandLineParameters.UninstallCommandParameters commandUninstall
    
    Uninstall command parameters
- Method Detail
  - java.lang.Boolean isBatchMode()
    
    Verifies if is the batch option is activated as main parameter or command parameter
    Returns:
    true if the batch option is activated as main parameter or command parameter
  - java.lang.Boolean isHelp()
    
    Verifies if is the help option is activated as main parameter or command parameter
    Returns:
    true if the help option is activated as main parameter or command parameter
  - java.lang.Boolean isVerbose()
    
    Verifies if is the verbose option is activated as main parameter or command parameter
    Returns:
    true if the verbose option is activated as main parameter or command parameter

Summary:
Nested
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class CommandLineParameters

Nested Class Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final java.lang.String BATCH_LONG_OPT

static final java.lang.String BATCH_SHORT_OPT

static final java.lang.String CATALOG_LONG_OPT

static final java.lang.String CONFLICT_LONG_OPT

static final java.lang.String DESCRIBE_CMD

static final java.lang.String FORCE_LONG_OPT

static final java.lang.String HELP_LONG_OPT

static final java.lang.String HELP_SHORT_OPT

static final java.lang.String INSTALLED_LONG_OPT

static final java.lang.String INSTALL_CMD

static final java.lang.String LIST_CMD

static final java.lang.String NO_CACHE_LONG_OPT

static final java.lang.String NO_COMPAT_LONG_OPT

static final java.lang.String OFFLINE_LONG_OPT

static final java.lang.String OUTDATED_LONG_OPT

static final java.lang.String SNAPSHOTS_LONG_OPT

static final java.lang.String UNINSTALL_CMD

static final java.lang.String UNSTABLE_LONG_OPT

static final java.lang.String VERBOSE_LONG_OPT

static final java.lang.String VERBOSE_SHORT_OPT

CommandLineParameters.Command command

CommandLineParameters.DescribeCommandParameters commandDescribe

CommandLineParameters.InstallCommandParameters commandInstall

CommandLineParameters.ListCommandParameters commandList

CommandLineParameters.UninstallCommandParameters commandUninstall

Method Detail

java.lang.Boolean isBatchMode()

java.lang.Boolean isHelp()

java.lang.Boolean isVerbose()