Package ghidra.features.base.values

Class AddressValue

java.lang.Object

docking.widgets.values.AbstractValue<Address>

ghidra.features.base.values.AddressValue

public class AddressValue
extends AbstractValue<Address>

Value class for Address types. In order to parse and create Address types, an AddressFactory is required when defining this type. As a convenience, it can be constructed with a Program, in which case it will use the AddressFactory from that program.

This class and other subclasses of AbstractValue are part of a subsystem for easily defining a set of values that can be displayed in an input dialog (ValuesMapDialog). Typically, these values are created indirectly using a GValuesMap which is then given to the constructor of the dialog. However, an alternate approach is to create the dialog without a ValuesMap and then use its ValuesMapDialog.addValue(AbstractValue) method directly.

Constructor Summary

Constructors

Constructor	Description
AddressValue(String name, Address defaultValue, AddressFactory factory)	Creates an AddressValue with an optional default value.
AddressValue(String name, Address defaultValue, Program program)	Creates an AddressValue with an optional default value and uses the AddressFactory from the given program.

Method Summary

Modifier and Type	Method	Description
protected Address	fromString(String valueString)	Parses the given string into a value of type T
JComponent	getComponent()	Returns a JComponent for entering or editing a value of this type.
protected void	updateComponentFromValue()	Updates the JComponent returned from AbstractValue.getComponent() to represent the current value of this object.
protected void	updateValueFromComponent()	Causes the stored value for this object to be updated based on the state of the JComponent returned from AbstractValue.getComponent()

Methods inherited from class docking.widgets.values.AbstractValue

copyValue, getAsText, getName, getValue, hasValue, reset, setAsText, setValue, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AddressValue

public AddressValue(String name,
 Address defaultValue,
 Program program)

Creates an AddressValue with an optional default value and uses the AddressFactory from the given program.

Parameters:

name - the name of this value

defaultValue - an optional default value

program - the program whose AddressFactory will be used to create Addresses.

AddressValue

public AddressValue(String name,
 Address defaultValue,
 AddressFactory factory)

Creates an AddressValue with an optional default value.

Parameters:

name - the name of this value

defaultValue - an optional default value

factory - the AddressFactory that will be used to create Addresses.

Method Details

getComponent

public JComponent getComponent()

Description copied from class: AbstractValue

Returns a JComponent for entering or editing a value of this type.

Specified by:

getComponent in class AbstractValue<Address>

Returns:

a JComponent for entering or editing a value of this type.

updateValueFromComponent

protected void updateValueFromComponent()
                                 throws ValuesMapParseException

Description copied from class: AbstractValue

Causes the stored value for this object to be updated based on the state of the JComponent returned from AbstractValue.getComponent()

Specified by:

updateValueFromComponent in class AbstractValue<Address>

Throws:

ValuesMapParseException - if an error occurs trying update the value from a component. This usually is a result of trying to parse a string value.

updateComponentFromValue

protected void updateComponentFromValue()

Description copied from class: AbstractValue

Updates the JComponent returned from AbstractValue.getComponent() to represent the current value of this object.

Specified by:

updateComponentFromValue in class AbstractValue<Address>

fromString

protected Address fromString(String valueString)

Description copied from class: AbstractValue

Parses the given string into a value of type T

Specified by:

fromString in class AbstractValue<Address>

Parameters:

valueString - the string to parse

Returns:

a value of type T