Package ghidra.framework.model
Interface ProjectData
- All Known Implementing Classes:
DefaultProjectData
,TransientProjectData
public interface ProjectData
The ProjectData interface provides access to all the data files and folders
in a project.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a listener that will be notified when any folder or file changes in the project.void
close()
Initiate disposal of this project data object.void
convertProjectToShared
(RepositoryAdapter repository, TaskMonitor monitor) Convert a local project to a shared project.findCheckedOutFiles
(TaskMonitor monitor) Find all project files which are currently checked-out to this projectvoid
findOpenFiles
(List<DomainFile> list) Finds all open domain files and appends them to the specified list.Get domain file specified by an absolute data path.getFileByID
(String fileID) Get domain file specified by its unique fileID.int
Get the approximate number of files contained within the project.Get domain folder specified by an absolute data path.Generate a local URL which corresponds to this project data if applicable.Class
<? extends LocalFileSystem> int
Returns the projectLocator for the this ProjectData.Return the repository for this project data.Returns the root folder of the project.Generate a repository URL which corresponds to this project data if applicable.getUser()
Returns User object associated with remote repository or null if a remote repository is not used.boolean
hasInvalidCheckouts
(List<DomainFile> checkoutList, RepositoryAdapter newRepository, TaskMonitor monitor) Determine if any domain files listed do not correspond to a checkout in the specified newRespository prior to invokingupdateRepositoryInfo(RepositoryAdapter, boolean, TaskMonitor)
.makeValidName
(String name) Transform the specified name into an acceptable folder or file item name.void
refresh
(boolean force) Sync the Domain folder/file structure with the underlying file structure.void
Removes the listener to be notified of folder and file changes.void
testValidName
(String name, boolean isPath) Validate a folder/item name or path.void
updateRepositoryInfo
(RepositoryAdapter newRepository, boolean force, TaskMonitor monitor) Update the repository for this project; the server may have changed or a different repository is being used.
-
Method Details
-
getLocalStorageClass
Class<? extends LocalFileSystem> getLocalStorageClass()- Returns:
- local storage implementation class
-
getRootFolder
DomainFolder getRootFolder()Returns the root folder of the project.- Returns:
- root
DomainFolder
within project.
-
getFolder
Get domain folder specified by an absolute data path.- Parameters:
path
- the absolute path of domain folder relative to the data folder.- Returns:
- domain folder or null if folder not found
-
getFileCount
int getFileCount()Get the approximate number of files contained within the project. The number may be reduced if not connected to the shared repository. Only the newer indexed file-system supports this capability, a value of -1 will be returned for older projects utilizing the mangled file-system or if an IO Error occurs. An approximate number is provided since the two underlying file systems are consulted separately and the local private file-system does not distinguish between checked-out files and private files. This number is currently intended as a rough sizing number to disable certain features when very large projects are in use. Generally the larger of the two file counts will be returned.- Returns:
- number of project files or -1 if unknown.
-
getFile
Get domain file specified by an absolute data path.- Parameters:
path
- the absolute path of domain file relative to the root folder.- Returns:
- domain file or null if file not found
-
findOpenFiles
Finds all open domain files and appends them to the specified list.- Parameters:
list
- the list to receive the open domain files
-
findCheckedOutFiles
Find all project files which are currently checked-out to this project- Parameters:
monitor
- task monitor (no progress updates)- Returns:
- list of current checkout files
- Throws:
IOException
- if IO error occursCancelledException
- if task cancelled
-
hasInvalidCheckouts
boolean hasInvalidCheckouts(List<DomainFile> checkoutList, RepositoryAdapter newRepository, TaskMonitor monitor) throws IOException, CancelledException Determine if any domain files listed do not correspond to a checkout in the specified newRespository prior to invokingupdateRepositoryInfo(RepositoryAdapter, boolean, TaskMonitor)
.- Parameters:
checkoutList
- project domain files to checknewRepository
- repository to check against before updatingmonitor
- task monitor- Returns:
- true if one or more files are not valid checkouts in newRepository
- Throws:
IOException
- if IO error occursCancelledException
- if task cancelled
-
getFileByID
Get domain file specified by its unique fileID.- Parameters:
fileID
- domain file ID- Returns:
- domain file or null if file not found
-
makeValidName
Transform the specified name into an acceptable folder or file item name. Only an individual folder or file name should be specified, since any separators will be stripped-out. NOTE: Uniqueness of name within the intended target folder is not considered.- Parameters:
name
-- Returns:
- valid name or "unknown" if no valid characters exist within name provided
-
getProjectLocator
ProjectLocator getProjectLocator()Returns the projectLocator for the this ProjectData.- Returns:
- project locator object
-
addDomainFolderChangeListener
Adds a listener that will be notified when any folder or file changes in the project.- Parameters:
listener
- the listener to be notified of folder and file changes.
-
removeDomainFolderChangeListener
Removes the listener to be notified of folder and file changes.- Parameters:
listener
- the listener to be removed.
-
refresh
void refresh(boolean force) Sync the Domain folder/file structure with the underlying file structure.- Parameters:
force
- if true all folders will be be visited and refreshed, if false only those folders previously visited will be refreshed.
-
getUser
User getUser()Returns User object associated with remote repository or null if a remote repository is not used.- Returns:
- current remote user identity or null
-
getRepository
RepositoryAdapter getRepository()Return the repository for this project data.- Returns:
- null if the project is not associated with a repository
-
updateRepositoryInfo
void updateRepositoryInfo(RepositoryAdapter newRepository, boolean force, TaskMonitor monitor) throws IOException, CancelledException Update the repository for this project; the server may have changed or a different repository is being used. Any existing checkout which is not recognized/valid by newRepository will be terminated and a local .keep file created. NOTE: The project should be closed and then reopened after this method is called.- Parameters:
newRepository
- new repository to useforce
- if true any existing local checkout which is not recognized/valid for newRepository will be forceably terminated if offline with old repository.monitor
- task monitor- Throws:
IOException
- thrown if files are still checked out, or if there was a problem accessing the filesystemCancelledException
- if the user canceled the update
-
close
void close()Initiate disposal of this project data object. Any files already open will delay disposal until they are closed. NOTE: This should only be invoked by the controlling object which created/opened this instance to avoid premature disposal. -
getMaxNameLength
int getMaxNameLength()- Returns:
- the maximum name length permitted for folders or items.
-
testValidName
Validate a folder/item name or path.- Parameters:
name
- folder or item nameisPath
- if true name represents full path- Throws:
InvalidNameException
- if name is invalid
-
getLocalProjectURL
URL getLocalProjectURL()Generate a local URL which corresponds to this project data if applicable. Remote transient project data will return null;- Returns:
- local URL which corresponds to this project data or null if not applicable.
-