Package ghidra.program.model.data
Class CharsetSettingsDefinition
- java.lang.Object
-
- ghidra.program.model.data.CharsetSettingsDefinition
-
- All Implemented Interfaces:
EnumSettingsDefinition,SettingsDefinition
public class CharsetSettingsDefinition extends java.lang.Object implements EnumSettingsDefinition
SettingsDefinitionfor setting the charset of a string instance.Charsets control how raw bytes are converted to native java String instances.
CharsetInfocontrols the list of character sets that the user is shown.
-
-
Field Summary
Fields Modifier and Type Field Description static CharsetSettingsDefinitionCHARSET
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear(Settings settings)Removes any values in the given settings object assocated with this settings definitionvoidcopySetting(Settings settings, Settings destSettings)Copies any setting value associated with this settings definition from the srcSettings settings to the destSettings.java.lang.StringgetCharset(Settings settings, java.lang.String defaultValue)intgetChoice(Settings settings)Returns the current value for this settingsjava.lang.StringgetDescription()Returns a description of this settings definitionjava.lang.StringgetDisplayChoice(int ordinalOfValue, Settings s1)Returns the String for the given enum valuejava.lang.String[]getDisplayChoices(Settings settings)Gets the list of choices as strings based on the current settingsjava.lang.StringgetName()Returns the name of this SettingsDefinitionbooleanhasValue(Settings setting)voidsetCharset(Settings settings, java.lang.String charset)voidsetChoice(Settings settings, int ordinalOfValue)Sets the given value into the settings object using this definition as a keystatic voidsetStaticEncodingMappingValues(java.util.Map<java.lang.Long,java.util.List<java.lang.String>> mappingValues)Sets a static lookup table that maps from old deprecated (language,encoding) index values to a charset name.
-
-
-
Field Detail
-
CHARSET
public static final CharsetSettingsDefinition CHARSET
-
-
Method Detail
-
getCharset
public java.lang.String getCharset(Settings settings, java.lang.String defaultValue)
-
setCharset
public void setCharset(Settings settings, java.lang.String charset)
-
getChoice
public int getChoice(Settings settings)
Description copied from interface:EnumSettingsDefinitionReturns the current value for this settings- Specified by:
getChoicein interfaceEnumSettingsDefinition- Parameters:
settings- The settings to search- Returns:
- the value for the settingsDefintions
-
setChoice
public void setChoice(Settings settings, int ordinalOfValue)
Description copied from interface:EnumSettingsDefinitionSets the given value into the settings object using this definition as a key- Specified by:
setChoicein interfaceEnumSettingsDefinition- Parameters:
settings- the settings to store the value.ordinalOfValue- the settings value to be stored.
-
getDisplayChoices
public java.lang.String[] getDisplayChoices(Settings settings)
Description copied from interface:EnumSettingsDefinitionGets the list of choices as strings based on the current settings- Specified by:
getDisplayChoicesin 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:SettingsDefinitionReturns the name of this SettingsDefinition- Specified by:
getNamein interfaceSettingsDefinition
-
getDescription
public java.lang.String getDescription()
Description copied from interface:SettingsDefinitionReturns a description of this settings definition- Specified by:
getDescriptionin interfaceSettingsDefinition
-
getDisplayChoice
public java.lang.String getDisplayChoice(int ordinalOfValue, Settings s1)Description copied from interface:EnumSettingsDefinitionReturns the String for the given enum value- Specified by:
getDisplayChoicein interfaceEnumSettingsDefinition- Parameters:
ordinalOfValue- 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
public void clear(Settings settings)
Description copied from interface:SettingsDefinitionRemoves any values in the given settings object assocated with this settings definition- Specified by:
clearin interfaceSettingsDefinition- Parameters:
settings- the settings object to be cleared.
-
copySetting
public void copySetting(Settings settings, Settings destSettings)
Description copied from interface:SettingsDefinitionCopies any setting value associated with this settings definition from the srcSettings settings to the destSettings.- Specified by:
copySettingin interfaceSettingsDefinition- Parameters:
settings- the settings to be copieddestSettings- the settings to be updated.
-
hasValue
public boolean hasValue(Settings setting)
- Specified by:
hasValuein interfaceSettingsDefinition
-
setStaticEncodingMappingValues
public static void setStaticEncodingMappingValues(java.util.Map<java.lang.Long,java.util.List<java.lang.String>> mappingValues)
Sets a static lookup table that maps from old deprecated (language,encoding) index values to a charset name.The old index values were used by old-style MBCS data type.
- Parameters:
mappingValues- map of language_id to list of charset names.
-
-