Package ghidra.framework.data

Class GhidraFolder

java.lang.Object

ghidra.framework.data.GhidraFolder

All Implemented Interfaces:

DomainFolder, java.lang.Comparable<DomainFolder>

Direct Known Subclasses:

RootGhidraFolder

public class GhidraFolder
extends java.lang.Object
implements DomainFolder

Field Summary

Fields inherited from interface ghidra.framework.model.DomainFolder

COPY_SUFFIX, SEPARATOR

Method Summary

Modifier and Type	Method	Description
int	compareTo(DomainFolder df)
GhidraFolder	copyTo(DomainFolder newParent, TaskMonitor monitor)	Copy this folder into the newParent folder.
DomainFile	createFile(java.lang.String fileName, DomainObject obj, TaskMonitor monitor)	Add a domain object to this folder.
DomainFile	createFile(java.lang.String fileName, java.io.File packFile, TaskMonitor monitor)	Add a new domain file to this folder.
GhidraFolder	createFolder(java.lang.String folderName)	Create a subfolder of this folder.
void	delete()	Deletes this folder and all of its contents
boolean	equals(java.lang.Object obj)
GhidraFile	getFile(java.lang.String fileName)	Get the domain file in this folder with the given name.
GhidraFile[]	getFiles()	Get all domain files in this folder.
GhidraFolder	getFolder(java.lang.String folderName)	Return the folder for the given name.
GhidraFolder[]	getFolders()	Get DomainFolders in this folder.
java.lang.String	getName()	Return this folder's name.
DomainFolder	getParent()	Return parent folder or null if this DomainFolder is the root folder.
java.lang.String	getPathname()	Returns the path name to the domain object.
ProjectFileManager	getProjectData()
ProjectLocator	getProjectLocator()	Returns the local storage location for the project that this DomainFolder belongs to.
int	hashCode()
boolean	isEmpty()	Determine if this folder contains any sub-folders or domain files.
boolean	isInWritableProject()	Returns true if this file is in a writable project.
GhidraFolder	moveTo(DomainFolder newParent)	Move this folder into the newParent folder.
void	setActive()	Allows the framework to react to a request to make this folder the "active" one.
GhidraFolder	setName(java.lang.String newName)	Set the name on this domain folder.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

compareTo

public int compareTo(DomainFolder df)

Specified by:

compareTo in interface java.lang.Comparable<DomainFolder>

getName

public java.lang.String getName()

Description copied from interface: DomainFolder

Return this folder's name.

Specified by:

getName in interface DomainFolder

setName

public GhidraFolder setName(java.lang.String newName)
                     throws InvalidNameException,
                            java.io.IOException

Description copied from interface: DomainFolder

Set the name on this domain folder.

Specified by:

setName in interface DomainFolder

Parameters:

newName - domain folder name

Returns:

renamed domain file (the original DomainFolder object becomes invalid since it is immutable)

Throws:

InvalidNameException - if newName contains illegal characters

DuplicateFileException - if a folder named newName already exists in this files domain folder.

FileInUseException - if any file within this folder or its decendents is in-use / checked-out.

java.io.IOException - thrown if an IO or access error occurs.

getProjectLocator

public ProjectLocator getProjectLocator()

Description copied from interface: DomainFolder

Returns the local storage location for the project that this DomainFolder belongs to.

Specified by:

getProjectLocator in interface DomainFolder

getProjectData

public ProjectFileManager getProjectData()

Specified by:

getProjectData in interface DomainFolder

getPathname

public java.lang.String getPathname()

Description copied from interface: DomainFolder

Returns the path name to the domain object.

Specified by:

getPathname in interface DomainFolder

isInWritableProject

public boolean isInWritableProject()

Description copied from interface: DomainFolder

Returns true if this file is in a writable project.

Specified by:

isInWritableProject in interface DomainFolder

getParent

public DomainFolder getParent()

Description copied from interface: DomainFolder

Return parent folder or null if this DomainFolder is the root folder.

Specified by:

getParent in interface DomainFolder

getFolders

public GhidraFolder[] getFolders()

Description copied from interface: DomainFolder

Get DomainFolders in this folder. This returns cached information and does not force a full refresh.

Specified by:

getFolders in interface DomainFolder

Returns:

list of sub-folders

getFolder

public GhidraFolder getFolder(java.lang.String folderName)

Description copied from interface: DomainFolder

Return the folder for the given name.

Specified by:

getFolder in interface DomainFolder

Parameters:

folderName - of folder to retrieve

Returns:

folder or null if there is no folder by the given name.

isEmpty

public boolean isEmpty()

Description copied from interface: DomainFolder

Determine if this folder contains any sub-folders or domain files.

Specified by:

isEmpty in interface DomainFolder

Returns:

true if this folder is empty.

getFiles

public GhidraFile[] getFiles()

Description copied from interface: DomainFolder

Get all domain files in this folder. This returns cached information and does not force a full refresh.

Specified by:

getFiles in interface DomainFolder

Returns:

list of domain files

getFile

public GhidraFile getFile(java.lang.String fileName)

Description copied from interface: DomainFolder

Get the domain file in this folder with the given name.

Specified by:

getFile in interface DomainFolder

Parameters:

fileName - name of file in this folder to retrieve

Returns:

domain file or null if there is no domain file in this folder with the given name.

createFile

public DomainFile createFile(java.lang.String fileName,
                             DomainObject obj,
                             TaskMonitor monitor)
                      throws InvalidNameException,
                             java.io.IOException,
                             CancelledException

Description copied from interface: DomainFolder

Add a domain object to this folder.

Specified by:

createFile in interface DomainFolder

Parameters:

fileName - domain file name

obj - domain object to be stored

monitor - progress monitor

Returns:

domain file created as a result of adding the domain object to this folder

Throws:

InvalidNameException - if name is an empty string or if it contains characters other than alphanumerics.

DuplicateFileException - thrown if the file name already exists

java.io.IOException - if IO or access error occurs

CancelledException - if the user cancels the create.

createFile

public DomainFile createFile(java.lang.String fileName,
                             java.io.File packFile,
                             TaskMonitor monitor)
                      throws InvalidNameException,
                             java.io.IOException,
                             CancelledException

Description copied from interface: DomainFolder

Add a new domain file to this folder.

Specified by:

createFile in interface DomainFolder

Parameters:

fileName - domain file name

packFile - packed file containing domain file data

monitor - progress monitor

Returns:

domain file created as a result of adding the domain object to this folder

Throws:

InvalidNameException - if name is an empty string or if it contains characters other than alphanumerics.

DuplicateFileException - thrown if the file name already exists

java.io.IOException - if IO or access error occurs

CancelledException - if the user cancels the create.

createFolder

public GhidraFolder createFolder(java.lang.String folderName)
                          throws InvalidNameException,
                                 java.io.IOException

Description copied from interface: DomainFolder

Create a subfolder of this folder.

Specified by:

createFolder in interface DomainFolder

Parameters:

folderName - sub-folder name

Throws:

InvalidNameException - if name is an empty string of if it contains characters other than alphanumerics.

DuplicateFileException - if a folder by this name already exists

java.io.IOException - if IO or access error occurs

delete

public void delete()
            throws java.io.IOException

Description copied from interface: DomainFolder

Deletes this folder and all of its contents

Specified by:

delete in interface DomainFolder

Throws:

java.io.IOException - if IO or access error occurs

FolderNotEmptyException - Thrown if the subfolder is not empty.

moveTo

public GhidraFolder moveTo(DomainFolder newParent)
                    throws java.io.IOException

Description copied from interface: DomainFolder

Move this folder into the newParent folder. If connected to an archive this affects both private and repository folders and files. If not connected, only private folders and files are affected.

Specified by:

moveTo in interface DomainFolder

Parameters:

newParent - new parent folder within the same project

Returns:

the newly relocated folder (the original DomainFolder object becomes invalid since it is immutable)

Throws:

DuplicateFileException - if a folder with the same name already exists in newParent folder.

FileInUseException - if this folder or one of its decendents contains a file which is in-use / checked-out.

java.io.IOException - thrown if an IO or access error occurs.

copyTo

public GhidraFolder copyTo(DomainFolder newParent,
                           TaskMonitor monitor)
                    throws java.io.IOException,
                           CancelledException

Description copied from interface: DomainFolder

Copy this folder into the newParent folder.

Specified by:

copyTo in interface DomainFolder

Parameters:

newParent - new parent folder

Throws:

DuplicateFileException - if a folder or file by this name already exists in the newParent folder

java.io.IOException - thrown if an IO or access error occurs.

CancelledException - if task monitor cancelled operation.

setActive

public void setActive()

Description copied from interface: DomainFolder

Allows the framework to react to a request to make this folder the "active" one.

Specified by:

setActive in interface DomainFolder

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object