Package ghidra.program.model.data
Class EndianSettingsDefinition
- java.lang.Object
-
- ghidra.program.model.data.EndianSettingsDefinition
-
- All Implemented Interfaces:
EnumSettingsDefinition
,SettingsDefinition
public class EndianSettingsDefinition extends java.lang.Object implements EnumSettingsDefinition
SettingsDefinition for endianess
-
-
Field Summary
Fields Modifier and Type Field Description static int
BIG
static EndianSettingsDefinition
DEF
static int
DEFAULT
static EndianSettingsDefinition
ENDIAN
static int
LITTLE
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear(Settings settings)
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.int
getChoice(Settings settings)
Returns the current value for this settingsjava.lang.String
getDescription()
Returns a description of this settings definitionjava.lang.String
getDisplayChoice(int value, Settings settings)
Returns the String for the given enum valuejava.lang.String[]
getDisplayChoices(Settings settings)
Gets the list of choices as strings based on the current settingsEndian
getEndianess(Settings settings, Endian defaultValue)
java.lang.String
getName()
Returns the name of this SettingsDefinitionboolean
hasValue(Settings setting)
boolean
isBigEndian(Settings settings, MemBuffer buf)
Returns the endianess settings.void
setBigEndian(Settings settings, boolean isBigEndian)
void
setChoice(Settings settings, int value)
Sets the given value into the settings object using this definition as a key
-
-
-
Field Detail
-
DEF
public static final EndianSettingsDefinition DEF
-
ENDIAN
public static final EndianSettingsDefinition ENDIAN
-
DEFAULT
public static final int DEFAULT
- See Also:
- Constant Field Values
-
LITTLE
public static final int LITTLE
- See Also:
- Constant Field Values
-
BIG
public static final int BIG
- See Also:
- Constant Field Values
-
-
Method Detail
-
isBigEndian
public boolean isBigEndian(Settings settings, MemBuffer buf)
Returns the endianess settings. First looks in settings, then defaultSettings and finally returns a default value if the first two have no value for this definition.- Parameters:
settings
- the instance settings to search for the valuebuf
- the data context- Returns:
- a boolean value for the endianess setting
-
setBigEndian
public void setBigEndian(Settings settings, boolean isBigEndian)
-
getChoice
public int getChoice(Settings settings)
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
-
setChoice
public void setChoice(Settings settings, int value)
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.
-
getDisplayChoices
public java.lang.String[] getDisplayChoices(Settings settings)
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
public java.lang.String getName()
Description copied from interface:SettingsDefinition
Returns the name of this SettingsDefinition- Specified by:
getName
in interfaceSettingsDefinition
-
getDescription
public java.lang.String getDescription()
Description copied from interface:SettingsDefinition
Returns a description of this settings definition- Specified by:
getDescription
in interfaceSettingsDefinition
-
getDisplayChoice
public java.lang.String getDisplayChoice(int value, Settings settings)
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 forsettings
- the instance settings which may affect the results- Returns:
- the display string for the given settings.
-
clear
public void clear(Settings settings)
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
public void copySetting(Settings settings, Settings destSettings)
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
public boolean hasValue(Settings setting)
- Specified by:
hasValue
in interfaceSettingsDefinition
-
-