Package ghidra.framework.store.local
Class UnknownFolderItem
java.lang.Object
ghidra.framework.store.local.LocalFolderItem
ghidra.framework.store.local.UnknownFolderItem
- All Implemented Interfaces:
FolderItem
UnknownFolderItem
acts as a LocalFolderItem place-holder for
items of an unknown type.-
Field Summary
Fields inherited from interface ghidra.framework.store.FolderItem
DATABASE_FILE_TYPE, DATAFILE_FILE_TYPE, DEFAULT_CHECKOUT_ID, LATEST_VERSION, UNKNOWN_FILE_TYPE
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if unsaved file changes can be recovered.void
Clears the checkout data associated with this non-shared file.getCheckout
(long checkoutId) Get the checkout status which corresponds to the specified checkout ID.Get all current checkouts for this item.Return The content type name for this item.int
Return the latest/current version.Version[]
Returns list of all available versions or null if item is not versioned.long
length()
Returns the length of this domain file.void
output
(File outputFile, int version, TaskMonitor monitor) Serialize (i.e., pack) this item into the specified outputFile.void
setCheckout
(long checkoutId, int checkoutVersion, int localVersion) void
terminateCheckout
(long checkoutId) void
updateCheckout
(FolderItem versionedFolderItem, boolean updateItem, TaskMonitor monitor) Update this non-versioned item with the latest version of the specified versioned item.void
updateCheckout
(FolderItem item, int checkoutVersion) Update this non-versioned item with the contents of the specified item which must be within the same non-versioned fileSystem.Methods inherited from class ghidra.framework.store.local.LocalFolderItem
checkout, delete, equals, getCheckoutId, getCheckoutVersion, getContentTypeVersion, getFileID, getLocalCheckoutVersion, getName, getParentPath, getPathName, hasCheckouts, isCheckedOut, isCheckedOutExclusive, isCheckinActive, isReadOnly, isVersioned, lastModified, refresh, resetFileID, setCheckout, setContentTypeVersion, setReadOnly, terminateCheckout, updateCheckoutVersion
-
Field Details
-
UNKNOWN_CONTENT_TYPE
- See Also:
-
-
Method Details
-
length
Description copied from interface:FolderItem
Returns the length of this domain file. This size is the minimum disk space used for storing this file, but does not account for additional storage space used to tracks changes, etc.- Returns:
- file length
- Throws:
IOException
- thrown if IO or access error occurs
-
updateCheckout
public void updateCheckout(FolderItem versionedFolderItem, boolean updateItem, TaskMonitor monitor) throws IOException Description copied from class:LocalFolderItem
Update this non-versioned item with the latest version of the specified versioned item.- Specified by:
updateCheckout
in classLocalFolderItem
- Parameters:
versionedFolderItem
- versioned item which corresponds to this non-versioned item.updateItem
- if true this items content is updated using the versionedFolderItemmonitor
- progress monitor for update- Throws:
IOException
- if this file is not a checked-out non-versioned file or an IO error occurs.
-
updateCheckout
Description copied from class:LocalFolderItem
Update this non-versioned item with the contents of the specified item which must be within the same non-versioned fileSystem. If successful, the specified item will be removed after its content has been moved into this item.- Specified by:
updateCheckout
in classLocalFolderItem
- Parameters:
item
-checkoutVersion
-- Throws:
IOException
- if this file is not a checked-out non-versioned file or an IO error occurs.
-
checkout
- Throws:
IOException
-
terminateCheckout
public void terminateCheckout(long checkoutId) -
clearCheckout
Description copied from interface:FolderItem
Clears the checkout data associated with this non-shared file. NOTE: This method is only valid for a local non-versioned file-system.- Specified by:
clearCheckout
in interfaceFolderItem
- Overrides:
clearCheckout
in classLocalFolderItem
- Throws:
IOException
-
setCheckout
public void setCheckout(long checkoutId, int checkoutVersion, int localVersion) -
getCheckout
Description copied from interface:FolderItem
Get the checkout status which corresponds to the specified checkout ID.- Specified by:
getCheckout
in interfaceFolderItem
- Overrides:
getCheckout
in classLocalFolderItem
- Parameters:
checkoutId
- checkout ID- Returns:
- checkout status or null if checkout ID not found.
- Throws:
IOException
- if an IO error occurs or this item is not versioned
-
getCheckouts
Description copied from interface:FolderItem
Get all current checkouts for this item.- Specified by:
getCheckouts
in interfaceFolderItem
- Overrides:
getCheckouts
in classLocalFolderItem
- Returns:
- array of checkouts
- Throws:
IOException
- if an IO error occurs or this item is not versioned
-
getVersions
Description copied from interface:FolderItem
Returns list of all available versions or null if item is not versioned.- Specified by:
getVersions
in interfaceFolderItem
- Overrides:
getVersions
in classLocalFolderItem
- Throws:
IOException
- thrown if an IO error occurs.- See Also:
-
getContentType
Description copied from interface:FolderItem
Return The content type name for this item.- Specified by:
getContentType
in interfaceFolderItem
- Overrides:
getContentType
in classLocalFolderItem
- See Also:
-
output
Description copied from interface:FolderItem
Serialize (i.e., pack) this item into the specified outputFile.- Parameters:
outputFile
- packed output file to be createdversion
- if this item is versioned, specifies the version to be output, otherwise -1 should be specified.monitor
- progress monitor- Throws:
IOException
-
getCurrentVersion
public int getCurrentVersion()Description copied from interface:FolderItem
Return the latest/current version. -
canRecover
public boolean canRecover()Description copied from interface:FolderItem
Returns true if unsaved file changes can be recovered.
-