Package ghidra.program.model.data
Class PointerTypeSettingsDefinition
java.lang.Object
ghidra.program.model.data.PointerTypeSettingsDefinition
- All Implemented Interfaces:
EnumSettingsDefinition
,SettingsDefinition
,TypeDefSettingsDefinition
public class PointerTypeSettingsDefinition
extends Object
implements EnumSettingsDefinition, TypeDefSettingsDefinition
The settings definition for the numeric display format
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Removes any values in the given settings object assocated with this settings definitionvoid
copySetting
(Settings settings, Settings destSettings) Copies any setting value associated with this settings definition from the srcSettings settings to the destSettings.getAttributeSpecification
(Settings settings) Get theTypeDef
attribute specification for this setting and its current value.int
Returns the current value for this settingsReturns a description of this settings definitiongetDisplayChoice
(int value, Settings s1) Returns the String for the given enum valuegetDisplayChoice
(Settings settings) String[]
getDisplayChoices
(Settings settings) Gets the list of choices as strings based on the current settingsgetName()
Returns the display name of this SettingsDefinitionGet theSettings
key which is used when storing a key/value entry.Returns the format based on the specified settingsgetValueString
(Settings settings) Get the setting value as a string which corresponds to this definition.boolean
Determine if a setting value has been storedvoid
Sets the given value into the settings object using this definition as a keyvoid
setDisplayChoice
(Settings settings, String choice) Sets the settings object to the enum value indicating the specified choice as a string.void
setType
(Settings settings, PointerType type) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface ghidra.docking.settings.EnumSettingsDefinition
hasSameValue
-
Field Details
-
DEF
-
-
Method Details
-
getType
Returns the format based on the specified settings- Parameters:
settings
- the instance settings or null for default value.- Returns:
- the
PointerType
.PointerType.DEFAULT
will be returned if no setting has been made.
-
getChoice
Description copied from interface:EnumSettingsDefinition
Returns the current value for this settings- Specified by:
getChoice
in interfaceEnumSettingsDefinition
- Parameters:
settings
- The settings to search- Returns:
- the value for the settingsDefintions
-
getValueString
Description copied from interface:SettingsDefinition
Get the setting value as a string which corresponds to this definition. A default value string will be returned if a setting has not been stored.- Specified by:
getValueString
in interfaceSettingsDefinition
- Parameters:
settings
- settings- Returns:
- value string or null if not set and default has not specified by this definition
-
setChoice
Description copied from interface:EnumSettingsDefinition
Sets the given value into the settings object using this definition as a key- Specified by:
setChoice
in interfaceEnumSettingsDefinition
- Parameters:
settings
- the settings to store the value.value
- the settings value to be stored.
-
setType
-
getDisplayChoices
Description copied from interface:EnumSettingsDefinition
Gets the list of choices as strings based on the current settings- Specified by:
getDisplayChoices
in interfaceEnumSettingsDefinition
- Parameters:
settings
- the instance settings- Returns:
- an array of strings which represent valid choices based on the current settings.
-
getName
Description copied from interface:SettingsDefinition
Returns the display name of this SettingsDefinition- Specified by:
getName
in interfaceSettingsDefinition
- Returns:
- display name for setting
-
getStorageKey
Description copied from interface:SettingsDefinition
Get theSettings
key which is used when storing a key/value entry.- Specified by:
getStorageKey
in interfaceSettingsDefinition
- Returns:
- settings storage key
-
getDescription
Description copied from interface:SettingsDefinition
Returns a description of this settings definition- Specified by:
getDescription
in interfaceSettingsDefinition
- Returns:
- setting description
-
getDisplayChoice
Description copied from interface:EnumSettingsDefinition
Returns the String for the given enum value- Specified by:
getDisplayChoice
in interfaceEnumSettingsDefinition
- Parameters:
value
- the value to get a display string fors1
- the instance settings which may affect the results- Returns:
- the display string for the given settings.
-
clear
Description copied from interface:SettingsDefinition
Removes any values in the given settings object assocated with this settings definition- Specified by:
clear
in interfaceSettingsDefinition
- Parameters:
settings
- the settings object to be cleared.
-
copySetting
Description copied from interface:SettingsDefinition
Copies any setting value associated with this settings definition from the srcSettings settings to the destSettings.- Specified by:
copySetting
in interfaceSettingsDefinition
- Parameters:
settings
- the settings to be copieddestSettings
- the settings to be updated.
-
hasValue
Description copied from interface:SettingsDefinition
Determine if a setting value has been stored- Specified by:
hasValue
in interfaceSettingsDefinition
- Parameters:
setting
- stored settings- Returns:
- true if a value has been stored, else false
-
getDisplayChoice
-
setDisplayChoice
Sets the settings object to the enum value indicating the specified choice as a string.- Parameters:
settings
- the settings to store the value.choice
- enum string representing a choice in the enum.
-
getAttributeSpecification
Description copied from interface:TypeDefSettingsDefinition
Get theTypeDef
attribute specification for this setting and its current value.- Specified by:
getAttributeSpecification
in interfaceTypeDefSettingsDefinition
- Parameters:
settings
- typedef settings- Returns:
- attribute specification or null if not currently set.
-