LauncherConf (MDIFramework API)

java.lang.Object
- org.mdi.app.LauncherConf

```
public class LauncherConf
extends java.lang.Object
```
This singleton class allows to find the user.dir and user.home directories even when the application is launched remotely. To use it:
- Create the LauncherConf class by providing the path for one of the resources in the Application. Optionally you can also provide an environment variable which will specify the user.home directory
- Use the user.dir and user.home directory provided by this class instead of the ones provided by the Java System class

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static LauncherConf`	`create(java.lang.Class clazz)` Create the singleton class if it did not previously exist.
`static LauncherConf`	`create(java.lang.Class clazz, java.lang.String envHome)` Create the singleton class if it did not previously exist.
`static LauncherConf`	`create(java.io.File userDir)` Create the singleton class if it did not previously exist.
`static LauncherConf`	`create(java.io.File userDir, java.io.File userHome)` Create the singleton class if it did not previously exist.
`static LauncherConf`	`create(java.io.File userDir, java.lang.String envHome)` Create the singleton class if it did not previously exist.
`static LauncherConf`	`create(java.net.URL userDir)` Create the singleton instance if it did not previously exist.
`static LauncherConf`	`create(java.net.URL userDir, java.lang.String envHome)` Create the singleton class if it did not previously exist.
`static LauncherConf`	`create(java.net.URL userDir, java.net.URL userHome)` Create the singleton class if it did not previously exist.
`static void`	`filterLaunchProperties(java.util.Map<java.lang.String,java.lang.String> args, java.lang.String... filteredArgs)` Filter the launch properties of the main application.
`static LauncherConf`	`getInstance()` Return the unique LauncherConf instance.
`static java.util.Map<java.lang.String,java.lang.String>`	`getLaunchProperties(java.lang.String[] args)` Store the launch arguments of a main static method into a Map of <key,value>.
`static java.util.Map<java.lang.String,java.lang.String>`	`getLaunchProperties(java.lang.String[] args, boolean keepDash)` Store the launch arguments of a main static method into a Map of <key,value>.
`java.io.File`	`getUserDir()` Return the user.dir directory.
`java.net.URL`	`getUserDirURL()` Return the user.dir directory.
`java.io.File`	`getUserHome()` Return the user.home directory.
`java.net.URL`	`getUserHomeURL()` Return the user.home directory.
`static boolean`	`isLocked()` Retur true if the current LauncherConf instance is locked.
`void`	`lock()` Lock the current LauncherConf instance such as to prevent further `reset()` to have any effect.
`static boolean`	`reset()` Reset the existing user configuration.
`static void`	`restart(MDIApplication appli)` Exit then restart the application with the same options.

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

- Method Detail
  - lock
```
public void lock()
```
    Lock the current LauncherConf instance such as to prevent further reset() to have any effect. This means that the current LauncherConf instance can not be replaced.
    
    See Also:
    
    reset()
  - isLocked
```
public static boolean isLocked()
```
    Retur true if the current LauncherConf instance is locked.
    
    Returns:
    
    true if the current LauncherConf instance is locked
  - restart
```
public static void restart(MDIApplication appli)
                    throws java.lang.Exception
```
    Exit then restart the application with the same options. The method will call MDIApplication.disposeApplication() to exit if appli is not null, else it will simply call System.exit(0).
    
    Parameters:
    
    appli - the MDIApplication (can be null)
    
    Throws:
    
    java.lang.Exception - if an exception occur before restarting
  - getInstance
```
public static LauncherConf getInstance()
```
    Return the unique LauncherConf instance. Note that if it was not created before, it will be created, with the system user.dir and user.home for the getUserDir() and getUserHome().
    
    Returns:
    
    the unique LauncherConf instance
  - reset
```
public static boolean reset()
```
    Reset the existing user configuration. Basically after this method the singleton instance will be set as not existing, such that the various getInstance() and other create methods will be able to recreate it. Note that it won't succeed if the current LauncherConf instance is locked.
    Example
```
 LauncherConf launcherConf = LauncherConf.getInstance();
 File userDir = launcherConf.getUserDir();
 if (userDir == null) {
   LauncherConf.reset();
   launcherConf = LauncherConf.create(MyClass.class);
   userDir = launcherConf.getUserDir();
 }
 launcherConf.lock();
 
```
    Returns:
    
    true if the reset succeeded. Will return false if isLocked() is true
  - create
```
public static LauncherConf create(java.net.URL userDir)
```
    Create the singleton instance if it did not previously exist.
    
    Parameters:
    
    userDir - the forced user directory as a URL
    
    Returns:
    
    the LauncherConf singleton instance
  - create
```
public static LauncherConf create(java.io.File userDir)
```
    Create the singleton class if it did not previously exist.
    
    Parameters:
    
    userDir - the forced user directory
    
    Returns:
    
    the LauncherConf singleton instance
  - create
```
public static LauncherConf create(java.io.File userDir,
                                  java.io.File userHome)
```
    Create the singleton class if it did not previously exist.
    
    Parameters:
    
    userDir - the forced user.dir directory
    
    userHome - the forced user.home directory
    
    Returns:
    
    the LauncherConf singleton instance
  - create
```
public static LauncherConf create(java.net.URL userDir,
                                  java.net.URL userHome)
```
    Create the singleton class if it did not previously exist.
    
    Parameters:
    
    userDir - the forced user.dir directory
    
    userHome - the forced user.home directory
    
    Returns:
    
    the LauncherConf singleton instance
  - create
```
public static LauncherConf create(java.lang.Class clazz)
```
    Create the singleton class if it did not previously exist.
    
    Parameters:
    
    clazz - the Class used for the user directory
    
    Returns:
    
    the LauncherConf singleton instance
  - create
```
public static LauncherConf create(java.io.File userDir,
                                  java.lang.String envHome)
```
    Create the singleton class if it did not previously exist.
    
    Parameters:
    
    userDir - the forced user directory
    
    envHome - the optional environment variable giving the path for the user.home directory
    
    Returns:
    
    the LauncherConf singleton instance
  - create
```
public static LauncherConf create(java.net.URL userDir,
                                  java.lang.String envHome)
```
    Create the singleton class if it did not previously exist.
    
    Parameters:
    
    userDir - the forced user directory
    
    envHome - the optional environment variable giving the path for the user.home directory
    
    Returns:
    
    the LauncherConf singleton instance
  - create
```
public static LauncherConf create(java.lang.Class clazz,
                                  java.lang.String envHome)
```
    Create the singleton class if it did not previously exist.
    
    Parameters:
    
    clazz - the Class used for the user directory
    
    envHome - the optional environment variable giving the path for the user.home directory
    
    Returns:
    
    the LauncherConf singleton instance
  - filterLaunchProperties
```
public static void filterLaunchProperties(java.util.Map<java.lang.String,java.lang.String> args,
                                          java.lang.String... filteredArgs)
```
    Filter the launch properties of the main application.
    
    Parameters:
    
    args - the arguments
    
    filteredArgs - the filtered keys
  - getLaunchProperties
```
public static java.util.Map<java.lang.String,java.lang.String> getLaunchProperties(java.lang.String[] args)
```
    Store the launch arguments of a main static method into a Map of <key,value>. This call is equivalent to getLaunchProperties(java.lang.String[], boolean) with the keepDash argument set to false. The arguments can have one of the following pattern:
```
 key1 prop1 key2 prop2 ...
 
```
    or
```
 key1=prop1 key2=prop2 ...
 
```
    it is even possible to mix the two patterns such as:
```
 key1 prop1 key2=prop2 ...
 
```
    Parameters:
    
    args - the launch arguments
    
    Returns:
    
    the key, value pairs corresponding to the arguments
  - getLaunchProperties
```
public static java.util.Map<java.lang.String,java.lang.String> getLaunchProperties(java.lang.String[] args,
                                                                                   boolean keepDash)
```
    Store the launch arguments of a main static method into a Map of <key,value>. There are two modes:
    - Without keeping the dash character at the beginning of each argument
    - With keeping the dash character at the beginning of each argument
    Without keeping the dash character at the beginning of each argument
    In that mode, the dash character which might be present at the beginning of each argument is removed. The arguments can have one of the following pattern:
```
 key1 prop1 key2 prop2 ...
 
```
    or
```
 key1=prop1 key2=prop2 ...
 
```
    it is even possible to mix the two patterns such as:
```
 key1 prop1 key2=prop2 ...
 
```
    For example, if we have:
```
 key1 value1 -key2=value2 -key3 key4=23
 
```
    Then the method will return:
    - {"key1" => "value1", "key2 => "value2", "key3" => "", "key4" => "23"}
    With keeping the dash character at the beginning of each argument
    In that compatibility mode, the dash character which might be present at the beginning of each argument is not removed. For that mode, if an argument on the command-line has a value, the value of this argument must be set in that same argument. For example, if we have:
```
 -key1 -key2=value2 -key3 key4=23
 
```
    Then the method will return:
    - {"-key1" => "", "-key2 => "value2", "-key3" => "", "key4" => "23"}
    Parameters:
    
    args - the launch arguments
    
    keepDash - true if the dash character at the beginning of each argument must be kept
    
    Returns:
    
    the key, value pairs corresponding to the arguments
  - getUserDir
```
public java.io.File getUserDir()
```
    Return the user.dir directory.
    
    Returns:
    
    the user.dir directory
  - getUserHome
```
public java.io.File getUserHome()
```
    Return the user.home directory.
    
    Returns:
    
    the user.home directory
  - getUserDirURL
```
public java.net.URL getUserDirURL()
```
    Return the user.dir directory.
    
    Returns:
    
    the user.dir directory
  - getUserHomeURL
```
public java.net.URL getUserHomeURL()
```
    Return the user.home directory.
    
    Returns:
    
    the user.home directory

Class LauncherConf

Method Summary

Methods inherited from class java.lang.Object

Method Detail

lock

isLocked

restart

getInstance

reset

Example

create

create

create

create

create

create

create

create

filterLaunchProperties

getLaunchProperties

getLaunchProperties

Without keeping the dash character at the beginning of each argument

With keeping the dash character at the beginning of each argument

getUserDir

getUserHome

getUserDirURL

getUserHomeURL