BootiqueMain (SARL Agent Oriented Programming Language 0.12.0 API)

```
public class BootiqueMain
extends Object
```
Class that implements the standard main function for running a SARL application with bootique modules.

Since:

0.8

Version:

io.sarl.maven.bootiqueapp 0.12.0 20210527-171007

Author:

Stéphane Galland

Maven Group Id:

io.sarl.maven

Maven Artifact Id:

io.sarl.maven.bootiqueapp

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`D_PATTERN` Pattern for command-line definition.
`static String`	`DEFAULT_LOG_FORMAT` Default log format for a bootique app.
`static int`	`ERROR_CODE` Return code when failure.

Constructor Summary

Constructors
Constructor and Description
`BootiqueMain(experimental : boolean, providers : io.bootique.BQModuleProvider*)` Constructor.
`BootiqueMain(providers : io.bootique.BQModuleProvider*)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected io.bootique.BQRuntime`	`createRuntime(modules : Class<? extends io.bootique.BQModuleProvider>[], args : String*)` Create the compiler runtime.
`protected io.bootique.BQRuntime`	`createRuntime(args : String*)` Create the compiler runtime.
`static String[]`	`filterCommandLineArguments(args : String[])` Filter the command-line arguments for extracting the -D parameters.
`List<io.bootique.help.HelpOption>`	`getOptions()` Replies the options of the program.
`List<io.bootique.help.HelpOption>`	`getOptionsForModules(modules : Class<? extends io.bootique.BQModuleProvider>[])` Replies the options of the program that are provided by a specific set of modules.
`static Class<? extends io.bootique.BQModuleProvider>[]`	`getStaticModuleProvidersFor(names : String[])` Replies the statically defined modules.
`boolean`	`isExperimental()` Replies if this application is an experimental application.
`int`	`runCommand(args : String*)` Run the associated commands.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ERROR_CODE
```
public static val ERROR_CODE : int
```
    Description copied from class: BootiqueMain
    
    Return code when failure.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LOG_FORMAT
```
public static val DEFAULT_LOG_FORMAT : String
```
    Description copied from class: BootiqueMain
    
    Default log format for a bootique app.
    
    See Also:
    
    Constant Field Values
  - D_PATTERN
```
public static val D_PATTERN : String
```
    Description copied from class: BootiqueMain
    
    Pattern for command-line definition.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BootiqueMain
```
public new(providers : io.bootique.BQModuleProvider*)
```
    Constructor.
    
    Parameters:
    
    providers - the providers of module that injects application-specific components.
  - BootiqueMain
```
public new(experimental : boolean,
           providers : io.bootique.BQModuleProvider*)
```
    Constructor.
    
    Parameters:
    
    experimental - indicates if the application is experimental.
    
    providers - the providers of module that injects application-specific components.
- Method Detail
  - isExperimental
```
public def isExperimental() : boolean 
```
    Description copied from class: BootiqueMain
    
    Replies if this application is an experimental application.
    Usually a warning message is displayed at launch time when the application is experimental.
    
    Returns:
    
    true if experimental.
  - createRuntime
```
protected def createRuntime(args : String*) : io.bootique.BQRuntime 
```
    Description copied from class: BootiqueMain
    
    Create the compiler runtime. This function loads any modules available on class-path that expose BQModuleProvider provider. Use with caution, you may load more modules than you expected. Make sure only needed Bootique dependencies are included on class-path. If in doubt, switch to explicit Module loading via BootiqueMain.createRuntime(Class[], String...).
    
    Parameters:
    
    args - the command line arguments.
    
    Returns:
    
    the runtime.
  - createRuntime
```
protected def createRuntime(modules : Class<? extends io.bootique.BQModuleProvider>[],
                            args : String*) : io.bootique.BQRuntime 
```
    Description copied from class: BootiqueMain
    
    Create the compiler runtime.
    
    Parameters:
    
    modules - the list of module to be loaded.
    
    args - the command line arguments.
    
    Returns:
    
    the runtime.
    
    Since:
    
    0.12
  - runCommand
```
public def runCommand(args : String*) : int 
```
    Description copied from class: BootiqueMain
    
    Run the associated commands.
    This function runs the command and exits with the return code.
    
    Parameters:
    
    args - the command line arguments.
    
    Returns:
    
    the exit code.
  - getOptions
```
public final def getOptions() : List<io.bootique.help.HelpOption> 
```
    Description copied from class: BootiqueMain
    
    Replies the options of the program. This function loads any modules available on class-path that expose BQModuleProvider provider. Use with caution, you may load more modules than you expected. Make sure only needed Bootique dependencies are included on class-path. If in doubt, switch to explicit Module loading via BootiqueMain.getOptionsForModules(Class...).
    
    Returns:
    
    the options of the program.
  - getOptionsForModules
```
public final def getOptionsForModules(modules : Class<? extends io.bootique.BQModuleProvider>[]) : List<io.bootique.help.HelpOption> 
```
    Description copied from class: BootiqueMain
    
    Replies the options of the program that are provided by a specific set of modules.
    
    Parameters:
    
    modules - the list of modules to be loaded.
    
    Returns:
    
    the options of the program.
    
    Since:
    
    0.12
  - getStaticModuleProvidersFor
```
public static def getStaticModuleProvidersFor(names : String[]) : Class<? extends io.bootique.BQModuleProvider>[] 
```
    Description copied from class: BootiqueMain
    
    Replies the statically defined modules.
    
    Parameters:
    
    names - the list of fully-qualified names of the modules providers.
    
    Returns:
    
    the list of the providers.
    
    Since:
    
    0.12
  - filterCommandLineArguments
```
public static def filterCommandLineArguments(args : String[]) : String[] 
```
    Description copied from class: BootiqueMain
    
    Filter the command-line arguments for extracting the -D parameters.
    
    Parameters:
    
    args - the arguments.
    
    Returns:
    
    the filtered arguments.
    
    Since:
    
    0.12

Class BootiqueMain

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ERROR_CODE

DEFAULT_LOG_FORMAT

D_PATTERN

Constructor Detail

BootiqueMain

BootiqueMain

Method Detail

isExperimental

createRuntime

createRuntime

runCommand

getOptions

getOptionsForModules

getStaticModuleProvidersFor

filterCommandLineArguments