IsApplication (SKB Interfaces 0.0.2 API)

All Superinterfaces:

CategoryHas, CategoryIs, HasDescription
```
public interface IsApplication
extends CategoryIs, HasDescription
```
Base interface for an application with different option types and default argument parsing.

Since:

v0.0.2

Version:

v0.0.2 build 170502 (02-May-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`addAllOptions(Iterable<?> options)` Adds options taken from an collection of objects.
`default void`	`addAllOptions(Object[] options)` Adds options taken from an array of objects.
`default void`	`addOption(Object option)` Adds a new option to the application.
`default void`	`appHelpScreen()` Prints a help screen for the application, to be used by an executing component.
`default void`	`appHelpScreen(String arg)` Prints specific help for a command line option of the application.
`default Apo_SimpleC`	`cliSimpleHelpOption()` Returns the required help option.
`default Apo_TypedC<String>`	`cliTypedHelpOption()` Returns the required help option.
`default Apo_SimpleC`	`cliVersionOption()` Returns the required version option.
`default int`	`executeApplication(String[] args)` Executes the application.
`String`	`getAppDescription()` Returns a 1 line description of the application, should not be null.
`default String`	`getAppDisplayName()` Returns the display name of the application.
`String`	`getAppName()` Returns the name of the application, which is the name of the executable object for instance a script.
`String`	`getAppVersion()` Returns version information of the application for command line processing of the version option.
`default Set<ApoBaseC>`	`getCLiALlOptions()` Returns all CLI options as base implementation.
`App_CliParser`	`getCliParser()` Returns the CLI parser.
`default Set<Apo_SimpleC>`	`getCliSimpleOptions()` Returns all CLI simple options.
`default Set<Apo_TypedC<?>>`	`getCliTypedOptions()` Returns all CLI typed options.
`default int`	`getConsoleWidth()` Returns the width of the console window, printable columns.
`default String`	`getDescription()` Returns the description of an object.
`Set<Apo_TypedE<?>>`	`getEnvironmentOptions()` Returns all environment options.
`Set<Apo_TypedP<?>>`	`getPropertyOptions()` Returns all property options.
`static boolean`	`IN_ARRAY(String[] array, ApoBaseC apo)` Simple utility to test if a CLI option (short or long) is in an array.
`String`	`longDescriptionString(Object longDescription)` Translates an option’s long help object into a string.

- Method Detail
  - IN_ARRAY
```
static boolean IN_ARRAY(String[] array,
                        ApoBaseC apo)
```
    Simple utility to test if a CLI option (short or long) is in an array.
    
    Parameters:
    
    array - the string array to test against
    
    apo - the option to search for
    
    Returns:
    
    true if the option, short or long, is in the array, false otherwise
  - addAllOptions
```
default void addAllOptions(Iterable<?> options)
```
    Adds options taken from an collection of objects.
    
    Parameters:
    
    options - object array, ignored if null, only application options will be taken
  - addAllOptions
```
default void addAllOptions(Object[] options)
```
    Adds options taken from an array of objects.
    
    Parameters:
    
    options - object array, ignored if null, only application options will be taken
  - addOption
```
default void addOption(Object option)
```
    Adds a new option to the application. Depending on its class, the option will be added to the environment options, the property options, and/or the CLI parser. If the class of the option is not supported, it will be ignored. Null values are ignored.
    
    Parameters:
    
    option - the option to be added, ignored if null
    
    Throws:
    
    IllegalStateException - if the option is already in use
  - appHelpScreen
```
default void appHelpScreen()
```
    Prints a help screen for the application, to be used by an executing component.
  - appHelpScreen
```
default void appHelpScreen(String arg)
```
    Prints specific help for a command line option of the application.
    
    Parameters:
    
    arg - the command line argument specific help is requested for
  - cliSimpleHelpOption
```
default Apo_SimpleC cliSimpleHelpOption()
```
    Returns the required help option.
    
    Returns:
    
    required help option, no help used if null, no typed option used if not null
  - cliTypedHelpOption
```
default Apo_TypedC<String> cliTypedHelpOption()
```
    Returns the required help option.
    
    Returns:
    
    required help option, no help used if null, ignored if simple help is used
  - cliVersionOption
```
default Apo_SimpleC cliVersionOption()
```
    Returns the required version option.
    
    Returns:
    
    required version option, no version used if null
  - executeApplication
```
default int executeApplication(String[] args)
```
    Executes the application. The default implementation will try to parse the command line with the application’s CLI object and if that does not return success (0), call the help screen automatically.
    
    Parameters:
    
    args - arguments for execution
    
    Returns:
    
    0 on success, negative integer on error, positive integer on no-error but exit application
  - getAppDescription
```
String getAppDescription()
```
    Returns a 1 line description of the application, should not be null.
    
    Returns:
    
    1-line application description, mainly used in default help screen implementation
  - getAppDisplayName
```
default String getAppDisplayName()
```
    Returns the display name of the application. This display name will be used for documentation and general user interaction. The default is the original application name.
    
    Returns:
    
    the application’s display name, default is the application name returned by getAppName(), must not be blank
  - getAppName
```
String getAppName()
```
    Returns the name of the application, which is the name of the executable object for instance a script. This application name will be used for information and error messages and user interactions.
    
    Returns:
    
    application name, must not be blank
  - getAppVersion
```
String getAppVersion()
```
    Returns version information of the application for command line processing of the version option.
    
    Returns:
    
    application version, should not be null
  - getCLiALlOptions
```
default Set<ApoBaseC> getCLiALlOptions()
```
    Returns all CLI options as base implementation.
    
    Returns:
    
    all CLI options, empty if none set
  - getCliParser
```
App_CliParser getCliParser()
```
    Returns the CLI parser.
    
    Returns:
    
    the CLI parser, must not be null
  - getCliSimpleOptions
```
default Set<Apo_SimpleC> getCliSimpleOptions()
```
    Returns all CLI simple options.
    
    Returns:
    
    CLI simple options, empty if none set
  - getCliTypedOptions
```
default Set<Apo_TypedC<?>> getCliTypedOptions()
```
    Returns all CLI typed options.
    
    Returns:
    
    CLI typed options, empty if none set
  - getConsoleWidth
```
default int getConsoleWidth()
```
    Returns the width of the console window, printable columns.
    
    Returns:
    
    width of the console window, default is 80
  - getDescription
```
default String getDescription()
```
    Description copied from interface: HasDescription
    
    Returns the description of an object.
    
    Specified by:
    
    getDescription in interface HasDescription
    
    Returns:
    
    description
  - getEnvironmentOptions
```
Set<Apo_TypedE<?>> getEnvironmentOptions()
```
    Returns all environment options.
    
    Returns:
    
    all environment options, empty array if none added
  - getPropertyOptions
```
Set<Apo_TypedP<?>> getPropertyOptions()
```
    Returns all property options.
    
    Returns:
    
    all property options, empty array if none added
  - longDescriptionString
```
String longDescriptionString(Object longDescription)
```
    Translates an option’s long help object into a string.
    
    Parameters:
    
    longDescription - the original long description of an option to translate
    
    Returns:
    
    the options long help, null and blank strings mean no long help available

Interface IsApplication

Method Summary

Method Detail

IN_ARRAY

addAllOptions

addAllOptions

addOption

appHelpScreen

appHelpScreen

cliSimpleHelpOption

cliTypedHelpOption

cliVersionOption

executeApplication

getAppDescription

getAppDisplayName

getAppName

getAppVersion

getCLiALlOptions

getCliParser

getCliSimpleOptions

getCliTypedOptions

getConsoleWidth

getDescription

getEnvironmentOptions

getPropertyOptions

longDescriptionString