Class AttributedSaveState

java.lang.Object

ghidra.framework.options.GProperties

ghidra.framework.options.XmlProperties

ghidra.framework.options.SaveState

ghidra.framework.options.AttributedSaveState

public class AttributedSaveState
extends SaveState

A version of SaveState that allows clients to add attributes to properties in this save state. The following code shows how to use this class:

AttributedSaveState ss = new AttributedSaveState();
ss.putBoolean("Happy", true);

Map<String, String> attrs = Map.of("MyAttribute", "AttributeValue");
ss.addAttrbibutes("Happy", attrs);

In this example, the property "Happy" will be given the attribute "MyAttribute" with the value of "AttributeValue". This is useful for clients that wish to add attributes to individual properties, such as a date for tracking usage.

Usage Note: The given attributes are only supported when writing and reading xml. Json is not supported.

Field Summary

Fields inherited from class GProperties

ATTRIBUTE_KEY, ATTRIBUTE_NAME, ATTRIBUTE_TYPE, ATTRIBUTE_VALUE, DATE_FORMAT, map, STATE

Constructor Summary

Constructors

Constructor	Description
AttributedSaveState()
AttributedSaveState(String name)
AttributedSaveState(org.jdom2.Element root)

Method Summary

Modifier and Type	Method	Description
void	addAttributes(String propertyName, Map<String,String> attributes)	Adds the given map of attribute name/value pairs to this save state.
protected SaveState	createSaveState(String name)
Map<String,String>	getAttributes(String propertyName)	Gets the attributes currently associated with the given property name
protected void	initializeElement(org.jdom2.Element e)
protected void	processElement(org.jdom2.Element element)	Called to restore this class' properties when restoring from xml.
void	removeAttributes(String propertyName)	Removes all attributes associated with the given property name.

Methods inherited from class SaveState

createElement, getSaveState, putSaveState, saveToFile

Methods inherited from class GProperties

clear, createElement, createElementFromElement, getAsType, getBoolean, getBooleans, getByte, getBytes, getColor, getDate, getDouble, getDoubles, getEnum, getFile, getFloat, getFloats, getFont, getGProperties, getInt, getInts, getKeyStroke, getLong, getLongs, getName, getNames, getShort, getShorts, getString, getStrings, getXmlElement, hasValue, isEmpty, putBoolean, putBooleans, putByte, putBytes, putColor, putDate, putDouble, putDoubles, putEnum, putFile, putFloat, putFloats, putFont, putGProperties, putInt, putInts, putKeyStroke, putLong, putLongs, putShort, putShorts, putString, putStrings, putXmlElement, remove, saveToJson, saveToJsonFile, saveToXml, saveToXmlFile, size, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AttributedSaveState

public AttributedSaveState()

AttributedSaveState

public AttributedSaveState(String name)

AttributedSaveState

public AttributedSaveState(org.jdom2.Element root)

Method Details

addAttributes

public void addAttributes(String propertyName,
 Map<String,String> attributes)

Adds the given map of attribute name/value pairs to this save state.

Parameters:

propertyName - the property name within this save state that will be attributed

attributes - the attributes

removeAttributes

public void removeAttributes(String propertyName)

Removes all attributes associated with the given property name.

Parameters:

propertyName - the property name within this save state that has the given attributes

getAttributes

public Map<String,String> getAttributes(String propertyName)

Gets the attributes currently associated with the given property name

Parameters:

propertyName - the property name for which to get attributes

Returns:

the attributes or null

createSaveState

protected SaveState createSaveState(String name)

Overrides:

createSaveState in class SaveState

initializeElement

protected void initializeElement(org.jdom2.Element e)

Overrides:

initializeElement in class GProperties

processElement

protected void processElement(org.jdom2.Element element)

Description copied from class: GProperties

Called to restore this class' properties when restoring from xml.

Overrides:

processElement in class SaveState

Parameters:

element - the element