Class AbstractOptionBuilder<ValueType, OptionType extends AbstractOption<ValueType>>

java.lang.Object

ghidra.app.util.AbstractOptionBuilder<ValueType, OptionType>

Type Parameters:

ValueType - The option value type

OptionType - The build option type

Direct Known Subclasses:

AddressOption.Builder, AddressSpaceOption.Builder, BooleanOption.Builder, HexLongOption.Builder, IntegerOption.Builder, StringOption.Builder

public abstract class AbstractOptionBuilder<ValueType, OptionType extends AbstractOption<ValueType>>
extends Object

A class to build AbstractOptions

Field Summary

Fields

Modifier and Type	Field	Description
protected String	commandLineArgument
protected String	description
protected String	group
protected boolean	hidden
protected String	name
protected String	stateKey
protected ValueType	value

Constructor Summary

Constructors

Constructor	Description
AbstractOptionBuilder(String name)	Creates a new AbstractOptionBuilder

Method Summary

Modifier and Type	Method	Description
abstract OptionType	build()	Returns a new AbstractOption based on the current state of this AbstractOptionBuilder.
AbstractOptionBuilder<ValueType, OptionType>	commandLineArgument(String arg)	Sets the Option's command line argument
AbstractOptionBuilder<ValueType, OptionType>	description(String desc)	Sets the Option's description
AbstractOptionBuilder<ValueType, OptionType>	group(String g)	Sets the Option's group
AbstractOptionBuilder<ValueType, OptionType>	hidden(boolean hide)	Sets whether or not the Option is hidden
AbstractOptionBuilder<ValueType, OptionType>	stateKey(String key)	Sets the Option's state key
AbstractOptionBuilder<ValueType, OptionType>	value(ValueType v)	Sets the Option's value

Methods inherited from class Object

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

Field Details

name

protected String name

group

protected String group

value

protected ValueType value

commandLineArgument

protected String commandLineArgument

description

protected String description

stateKey

protected String stateKey

hidden

protected boolean hidden

Constructor Details

AbstractOptionBuilder

public AbstractOptionBuilder(String name)

Creates a new AbstractOptionBuilder

Parameters:

name - The name of the Option to be built

Method Details

group

public AbstractOptionBuilder<ValueType, OptionType> group(String g)

Sets the Option's group

Parameters:

g - The Option's group

Returns:

This AbstractOptionBuilder

value

public AbstractOptionBuilder<ValueType, OptionType> value(ValueType v)

Sets the Option's value

Parameters:

v - The Option's value

Returns:

This AbstractOptionBuilder

commandLineArgument

public AbstractOptionBuilder<ValueType, OptionType> commandLineArgument(String arg)

Sets the Option's command line argument

Parameters:

arg - The Option's command line argument

Returns:

This AbstractOptionBuilder

description

public AbstractOptionBuilder<ValueType, OptionType> description(String desc)

Sets the Option's description

Parameters:

desc - The Option's description

Returns:

This AbstractOptionBuilder

stateKey

public AbstractOptionBuilder<ValueType, OptionType> stateKey(String key)

Sets the Option's state key

Parameters:

key - The Option's state key

Returns:

This AbstractOptionBuilder

hidden

public AbstractOptionBuilder<ValueType, OptionType> hidden(boolean hide)

Sets whether or not the Option is hidden

Parameters:

hide - True if the Option should be hidden; otherwise, false

Returns:

This AbstractOptionBuilder

build

public abstract OptionType build()

Returns a new AbstractOption based on the current state of this AbstractOptionBuilder.

Returns:

a new AbstractOption based on the current state of this AbstractOptionBuilder