Package ghidra.framework.store.local

Class IndexedPropertyFile

java.lang.Object

ghidra.util.PropertyFile

ghidra.framework.store.local.ItemPropertyFile

ghidra.framework.store.local.IndexedPropertyFile

public class IndexedPropertyFile
extends ItemPropertyFile

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	NAME_PROPERTY
protected static final String	PARENT_PATH_PROPERTY

Fields inherited from class ghidra.framework.store.local.ItemPropertyFile

name, parentPath

Fields inherited from class ghidra.util.PropertyFile

PROPERTY_EXT, propertyFile, storageName

Constructor Summary

Constructors

Constructor	Description
IndexedPropertyFile(File file)	Construct a existing PropertyFile.
IndexedPropertyFile(File dir, String storageName)	Construct a existing PropertyFile.
IndexedPropertyFile(File dir, String storageName, String parentPath, String name)	Construct a new or existing PropertyFile.

Method Summary

Modifier and Type	Method	Description
void	moveTo(File newParent, String newStorageName, String newParentPath, String newName)	Move this PropertyFile to the newParent file.

Methods inherited from class ghidra.framework.store.local.ItemPropertyFile

getFileID, getName, getParentPath, getPath, moveTo, setFileID

Methods inherited from class ghidra.util.PropertyFile

contains, delete, equals, exists, getBoolean, getInt, getLong, getParentStorageDirectory, getStorageName, getString, hashCode, isReadOnly, lastModified, putBoolean, putInt, putLong, putString, readState, remove, writeState

Methods inherited from class java.lang.Object

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

Field Details

NAME_PROPERTY

protected static final String NAME_PROPERTY

See Also:

• Constant Field Values

PARENT_PATH_PROPERTY

protected static final String PARENT_PATH_PROPERTY

See Also:

• Constant Field Values

Constructor Details

IndexedPropertyFile

public IndexedPropertyFile(File dir,
 String storageName,
 String parentPath,
 String name)
                    throws IOException

Construct a new or existing PropertyFile. This constructor ignores retained property values for NAME and PARENT path. This constructor will not throw an exception if the file does not exist.

Parameters:

dir - parent directory

storageName - stored property file name (without extension)

parentPath - path to parent

name - name of the property file

Throws:

InvalidObjectException - if a file parse error occurs

IOException - if an IO error occurs reading an existing file

IndexedPropertyFile

public IndexedPropertyFile(File dir,
 String storageName)
                    throws IOException

Construct a existing PropertyFile. This constructor uses property values for NAME and PARENT path.

Parameters:

dir - parent directory

storageName - stored property file name (without extension)

Throws:

FileNotFoundException - if property file does not exist

InvalidObjectException - if a file parse error occurs

IOException - if error occurs reading property file

IndexedPropertyFile

public IndexedPropertyFile(File file)
                    throws IOException

Construct a existing PropertyFile. This constructor uses property values for NAME and PARENT path.

Parameters:

file - property file

Throws:

FileNotFoundException - if property file does not exist

InvalidObjectException - if a file parse error occurs

IOException - if error occurs reading property file

Method Details

moveTo

public void moveTo(File newParent,
 String newStorageName,
 String newParentPath,
 String newName)
            throws DuplicateFileException,
IOException

Description copied from class: ItemPropertyFile

Move this PropertyFile to the newParent file.

Overrides:

moveTo in class ItemPropertyFile

Parameters:

newParent - new storage parent of the native file

newStorageName - new storage name for this property file

newParentPath - new logical parent path

newName - new logical item name

Throws:

DuplicateFileException - thrown if a file with the newName already exists

IOException - thrown if there was a problem accessing the