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, extensionInstallationDirs, modules, patchDir, 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, java.lang.String version)	Constructs a new docking application layout object with the given name and version.
DockingApplicationLayout(java.util.Collection<ResourceFile> applicationRootDirs, ApplicationProperties applicationProperties)	Constructs a new docking application layout object with the given set of application properties.

Method Summary

Modifier and Type	Method	Description
static java.util.Collection<ResourceFile>	getDefaultApplicationRootDirs()	Get the default list of Application directories.

Methods inherited from class utility.application.ApplicationLayout

createUserDirs, getApplicationInstallationDir, getApplicationProperties, getApplicationRootDirs, getExtensionArchiveDir, getExtensionInstallationDirs, getModules, getPatchDir, 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,
                                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. The default Ghidra application root directory(s) will be used.

Parameters:

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

Throws:

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

DockingApplicationLayout

public DockingApplicationLayout(java.util.Collection<ResourceFile> applicationRootDirs,
                                ApplicationProperties applicationProperties)
                         throws java.io.FileNotFoundException

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

Parameters:

applicationRootDirs - list of application root directories which should be used to idenitfy modules and resources. The first entry will be treated as the installation root.

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

Throws:

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

Method Detail

getDefaultApplicationRootDirs

public static java.util.Collection<ResourceFile> getDefaultApplicationRootDirs()

Get the default list of Application directories. In repo-based development mode this includes the root Ghidra directory within each repo. When not in development mode, the requirement is that the current working directory correspond to the installation root. The first entry will be the primary root in both cases.

Returns:

root directories