Class ProjectLocator

java.lang.Object
ghidra.framework.model.ProjectLocator

public class ProjectLocator extends Object
Lightweight descriptor of a local Project storage location.
  • Field Details

  • Constructor Details

    • ProjectLocator

      public ProjectLocator(String path, String name)
      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

      public URL getURL()
      Returns the URL associated with this local project. If using a temporary transient project location this URL should not be used.
    • getName

      public String getName()
      Get the name of the project identified by this project info.
    • getLocation

      public String 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

      public File getProjectDir()
      Returns the project directory
    • getMarkerFile

      public File getMarkerFile()
      Returns the file that indicates a Ghidra project.
    • getProjectLockFile

      public File getProjectLockFile()
      Returns project lock file to prevent multiple accesses to the same project at once.
    • getProjectDirExtension

      public static String getProjectDirExtension()
      Returns the project directory file extension.
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • getProjectExtension

      public static String getProjectExtension()
      Returns the file extension suitable for creating file filters for the file chooser.
    • isProjectDir

      public static boolean isProjectDir(File file)
      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