Package docking.framework

Class DockingApplicationLayout

java.lang.Object

utility.application.ApplicationLayout

docking.framework.DockingApplicationLayout

public class DockingApplicationLayout
extends ApplicationLayout

The docking application layout defines the customizable elements of a docking application's directory structure.

Field Summary

Fields inherited from class utility.application.ApplicationLayout

applicationInstallationDir, applicationProperties, applicationRootDirs, extensionArchiveDir, extensionInstallationDir, modules, userCacheDir, userSettingsDir, userTempDir

Constructor Summary

Constructors

Constructor	Description
DockingApplicationLayout(ApplicationProperties applicationProperties)	Constructs a new docking application layout object with the given set of application properties.
DockingApplicationLayout(java.lang.String name)	Constructs a new docking application layout object with the given name.
DockingApplicationLayout(java.lang.String name, java.lang.String version)	Constructs a new docking application layout object with the given name and version.

Method Summary

Methods inherited from class utility.application.ApplicationLayout

createUserDirs, getApplicationInstallationDir, getApplicationProperties, getApplicationRootDirs, getExtensionArchiveDir, getExtensionInstallationDir, getModules, getUserCacheDir, getUserSettingsDir, getUserTempDir, inSingleJarMode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DockingApplicationLayout

public DockingApplicationLayout(java.lang.String name)
                         throws java.io.FileNotFoundException,
                                java.io.IOException

Constructs a new docking application layout object with the given name.

Parameters:

name - The name of the application.

Throws:

java.io.FileNotFoundException - if there was a problem getting a user directory.

java.io.IOException

DockingApplicationLayout

public DockingApplicationLayout(java.lang.String name,
                                java.lang.String version)
                         throws java.io.FileNotFoundException

Constructs a new docking application layout object with the given name and version.

Parameters:

name - The name of the application.

version - The version of the application.

Throws:

java.io.FileNotFoundException - if there was a problem getting a user directory.

DockingApplicationLayout

public DockingApplicationLayout(ApplicationProperties applicationProperties)
                         throws java.io.FileNotFoundException

Constructs a new docking application layout object with the given set of application properties.

Parameters:

applicationProperties - The properties object that will be read system properties.

Throws:

java.io.FileNotFoundException - if there was a problem getting a user directory.