Package ghidra.util
Class SaveableColor
java.lang.Object
ghidra.util.PrivateSaveable
ghidra.util.SaveableColor
- All Implemented Interfaces:
Saveable
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
getColor()
Class<?>[]
Returns the field classes, in Java types, in the same order as usedSaveable.save(ghidra.util.ObjectStorage)
andSaveable.restore(ghidra.util.ObjectStorage)
.int
Get the storage schema version.int
hashCode()
boolean
isUpgradeable
(int oldSchemaVersion) Determine if the implementation supports an storage upgrade of the specified oldSchemaVersion to the current schema version.void
restore
(ObjectStorage objStorage) Restore from the given ObjectStorage.void
save
(ObjectStorage objStorage) Save to the given ObjectStorage.toString()
boolean
upgrade
(ObjectStorage oldObjStorage, int oldSchemaVersion, ObjectStorage currentObjStorage) Upgrade an older stored object to the current storage schema.Methods inherited from class ghidra.util.PrivateSaveable
isPrivate
-
Constructor Details
-
SaveableColor
-
SaveableColor
public SaveableColor()
-
-
Method Details
-
save
Description copied from interface:Saveable
Save to the given ObjectStorage.- Parameters:
objStorage
- Object that can handle Java primitives, Strings, and arrays of primitives and Strings
-
getObjectStorageFields
Description copied from interface:Saveable
Returns the field classes, in Java types, in the same order as usedSaveable.save(ghidra.util.ObjectStorage)
andSaveable.restore(ghidra.util.ObjectStorage)
.For example, if the save method calls
objStorage.putInt()
and thenobjStorage.putFloat()
, then this method must returnClass[]{ Integer.class, Float.class }
.- Returns:
-
restore
Description copied from interface:Saveable
Restore from the given ObjectStorage.- Parameters:
objStorage
- Object that can handle Java primitives, Strings, and arrays of primitives and Strings TODO: document how errors should be handled (i.e, exception, null return)
-
getColor
-
getSchemaVersion
public int getSchemaVersion()Description copied from interface:Saveable
Get the storage schema version. Any time there is a software release in which the implementing class has changed the data structure used for the save and restore methods, the schema version must be incremented. NOTE: While this could be a static method, the Saveable interface is unable to define such methods.- Returns:
- storage schema version.
-
isUpgradeable
public boolean isUpgradeable(int oldSchemaVersion) Description copied from interface:Saveable
Determine if the implementation supports an storage upgrade of the specified oldSchemaVersion to the current schema version.- Parameters:
oldSchemaVersion
-- Returns:
- true if upgrading is supported for the older schema version.
-
upgrade
public boolean upgrade(ObjectStorage oldObjStorage, int oldSchemaVersion, ObjectStorage currentObjStorage) Description copied from interface:Saveable
Upgrade an older stored object to the current storage schema.- Parameters:
oldObjStorage
- the old stored objectoldSchemaVersion
- storage schema version number for the old objectcurrentObjStorage
- new object for storage in the current schema- Returns:
- true if data was upgraded to the currentObjStorage successfully.
-
equals
-
hashCode
public int hashCode() -
toString
-