Package ghidra.program.database.bookmark
Class OldBookmark
- java.lang.Object
-
- ghidra.program.database.bookmark.OldBookmark
-
-
Constructor Summary
Constructors Constructor Description OldBookmark()
Constructs a Note Bookmark (required for Saveable property objects).OldBookmark(java.lang.String type, java.lang.String category, java.lang.String comment, Address addr)
Constructs a Bookmark.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
Return true if this object is the same as obj.Address
getAddress()
Get the address of this bookmark info.java.lang.String
getCategory()
java.lang.String
getComment()
java.lang.Class<?>[]
getObjectStorageFields()
Returns the field classes, in Java types, in the same order as usedSaveable.save(ghidra.util.ObjectStorage)
andSaveable.restore(ghidra.util.ObjectStorage)
.int
getSchemaVersion()
Get the storage schema version.java.lang.String
getType()
boolean
isPrivate()
Returns true if this saveable should not have it's changes broadcast.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.void
setCategory(java.lang.String category)
void
setComment(java.lang.String comment)
java.lang.String
toString()
boolean
upgrade(ObjectStorage oldObjStorage, int oldSchemaVersion, ObjectStorage currentObjStorage)
Upgrade an older stored object to the current storage schema.
-
-
-
Constructor Detail
-
OldBookmark
public OldBookmark(java.lang.String type, java.lang.String category, java.lang.String comment, Address addr)
Constructs a Bookmark.- Parameters:
type
-category
-comment
-addr
-
-
OldBookmark
public OldBookmark()
Constructs a Note Bookmark (required for Saveable property objects). Contains no address.
-
-
Method Detail
-
getType
public java.lang.String getType()
-
getCategory
public java.lang.String getCategory()
-
setCategory
public void setCategory(java.lang.String category)
-
getComment
public java.lang.String getComment()
-
setComment
public void setComment(java.lang.String comment)
-
getAddress
public Address getAddress()
Get the address of this bookmark info.- Returns:
- Address
-
equals
public boolean equals(java.lang.Object obj)
Return true if this object is the same as obj.- Overrides:
equals
in classjava.lang.Object
-
restore
public void restore(ObjectStorage objStorage)
Description copied from interface:Saveable
Restore from the given ObjectStorage.- Specified by:
restore
in interfaceSaveable
- Parameters:
objStorage
- Object that can handle Java primitives, Strings, and arrays of primitives and Strings- See Also:
Saveable.restore(ObjectStorage)
-
save
public void save(ObjectStorage objStorage)
Description copied from interface:Saveable
Save to the given ObjectStorage.- Specified by:
save
in interfaceSaveable
- Parameters:
objStorage
- Object that can handle Java primitives, Strings, and arrays of primitives and Strings- See Also:
Saveable.save(ObjectStorage)
-
getObjectStorageFields
public java.lang.Class<?>[] 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 }
.- Specified by:
getObjectStorageFields
in interfaceSaveable
- Returns:
-
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.- Specified by:
getSchemaVersion
in interfaceSaveable
- 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.- Specified by:
isUpgradeable
in interfaceSaveable
- 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.- Specified by:
upgrade
in interfaceSaveable
- 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.
-
isPrivate
public boolean isPrivate()
Description copied from interface:Saveable
Returns true if this saveable should not have it's changes broadcast.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-