Package ghidra.framework.model
Class ProjectLocator
java.lang.Object
ghidra.framework.model.ProjectLocator
Lightweight descriptor of a local Project storage location.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionProjectLocator
(String path, String name) Construct a project locator object. -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
exists()
Returns true if project storage existsGet the location of the project which will contain marker file (getMarkerFile()
) and project directory (getProjectDir()
).Returns the file that indicates a Ghidra project.getName()
Get the name of the project identified by this project info.Returns the project directorystatic String
Returns the project directory file extension.static String
Returns the file extension suitable for creating file filters for the file chooser.Returns project lock file to prevent multiple accesses to the same project at once.getURL()
Returns the URL associated with this local project.int
hashCode()
static boolean
isProjectDir
(File file) Returns whether the given file is a project directory.boolean
Returns true if this project URL corresponds to a transient project (e.g., corresponds to remote Ghidra URL)toString()
-
Field Details
-
PROJECT_FILE_SUFFIX
- See Also:
-
PROJECT_DIR_SUFFIX
- See Also:
-
-
Constructor Details
-
ProjectLocator
Construct a project locator object.- Parameters:
path
- path to parent directory (may or may not exist). The user's temp directory will be used if this value is null or blank. WARNING: Use of a relative paths should be avoided (e.g., on a windows platform an absolute path should start with a drive letter specification such as C:\path, while this same path on a Linux platform would be treated as relative).name
- name of the project
-
-
Method Details
-
isTransient
public boolean isTransient()Returns true if this project URL corresponds to a transient project (e.g., corresponds to remote Ghidra URL) -
getURL
Returns the URL associated with this local project. If using a temporary transient project location this URL should not be used. -
getName
Get the name of the project identified by this project info. -
getLocation
Get the location of the project which will contain marker file (getMarkerFile()
) and project directory (getProjectDir()
). Note: directory may or may not exist.- Returns:
- project location directory
-
getProjectDir
Returns the project directory -
getMarkerFile
Returns the file that indicates a Ghidra project. -
getProjectLockFile
Returns project lock file to prevent multiple accesses to the same project at once. -
getProjectDirExtension
Returns the project directory file extension. -
equals
-
hashCode
public int hashCode() -
toString
-
getProjectExtension
Returns the file extension suitable for creating file filters for the file chooser. -
isProjectDir
Returns whether the given file is a project directory.- Parameters:
file
- file to check- Returns:
- true if the file is a project directory
-
exists
public boolean exists()Returns true if project storage exists
-