Package ghidra.framework.store.local

Class IndexedPropertyFile

java.lang.Object

ghidra.util.PropertyFile

ghidra.framework.store.local.IndexedPropertyFile

public class IndexedPropertyFile
extends PropertyFile

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAME_PROPERTY
static java.lang.String	PARENT_PATH_PROPERTY

Fields inherited from class ghidra.util.PropertyFile

name, parentPath, PROPERTY_EXT, propertyFile, storageName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	moveTo(java.io.File newParent, java.lang.String newStorageName, java.lang.String newParentPath, java.lang.String newName)	Move this PropertyFile to the newParent file.
void	readState()	Read in this PropertyFile into a SaveState object.

Methods inherited from class ghidra.util.PropertyFile

delete, equals, exists, getBoolean, getFileID, getFolder, getInt, getLong, getName, getParentPath, getPath, getStorageName, getString, hashCode, isReadOnly, lastModified, putBoolean, putInt, putLong, putString, remove, setFileID, writeState

Methods inherited from class java.lang.Object

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

Field Detail

NAME_PROPERTY

public static final java.lang.String NAME_PROPERTY

See Also:

Constant Field Values

PARENT_PATH_PROPERTY

public static final java.lang.String PARENT_PATH_PROPERTY

See Also:

Constant Field Values

Constructor Detail

IndexedPropertyFile

public IndexedPropertyFile(java.io.File dir,
                           java.lang.String storageName,
                           java.lang.String parentPath,
                           java.lang.String name)
                    throws java.io.IOException

Construct a new or existing PropertyFile. This form ignores retained property values for NAME and PARENT path.

Parameters:

dir - parent directory

storageName - stored property file name (without extension)

parentPath - path to parent

name - name of the property file

Throws:

java.io.IOException

IndexedPropertyFile

public IndexedPropertyFile(java.io.File dir,
                           java.lang.String storageName)
                    throws java.io.IOException

Construct an existing PropertyFile.

Parameters:

dir - parent directory

storageName - stored property file name (without extension)

Throws:

java.io.FileNotFoundException - if property file does not exist

java.io.IOException - if error occurs reading property file

IndexedPropertyFile

public IndexedPropertyFile(java.io.File file)
                    throws java.io.IOException

Construct an existing PropertyFile.

Parameters:

file -

Throws:

java.io.FileNotFoundException - if property file does not exist

java.io.IOException - if error occurs reading property file

Method Detail

readState

public void readState()
               throws java.io.IOException

Description copied from class: PropertyFile

Read in this PropertyFile into a SaveState object.

Overrides:

readState in class PropertyFile

Throws:

java.io.IOException - thrown if there was a problem reading the file

moveTo

public void moveTo(java.io.File newParent,
                   java.lang.String newStorageName,
                   java.lang.String newParentPath,
                   java.lang.String newName)
            throws DuplicateFileException,
                   java.io.IOException

Description copied from class: PropertyFile

Move this PropertyFile to the newParent file.

Overrides:

moveTo in class PropertyFile

Parameters:

newParent - new parent of the file

newStorageName - new storage name

newParentPath - parent path of the new parent

newName - new name for this PropertyFile

Throws:

DuplicateFileException - thrown if a file with the newName already exists

java.io.IOException - thrown if there was a problem accessing the