journeymap.api.v2.common.option

Class Option<T>

java.lang.Object

journeymap.api.v2.common.option.Option<T>

Direct Known Subclasses:

BooleanOption, CustomOption, EnumOption, FloatOption, IntegerOption

public abstract class Option<T>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Config<T>	config
protected T	defaultValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Option(OptionCategory category, java.lang.String fieldName, java.lang.String label, T defaultValue) Parent for all options.

Method Summary

Modifier and Type	Method and Description
T	get()
OptionCategory	getCategory()
T	getDefaultValue()
java.lang.String	getFieldName()
java.lang.String	getLabel()
int	getSortOrder()
void	set(T value)
Option<T>	setSortOrder(int sortOrder) Used for sorting in the options pane.

Methods inherited from class java.lang.Object

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

Field Detail

defaultValue

protected final T defaultValue

config

protected Config<T> config

Constructor Detail

Option

protected Option(OptionCategory category,
                 java.lang.String fieldName,
                 java.lang.String label,
                 T defaultValue)

Parent for all options. For tooltips, your i18n key plus .tooltip in your language json example mod.option.label and mod.option.label.tooltip

Parameters:

category - - The category.

fieldName - - The field name.

label - - the label, can be the display string or i18n key.

defaultValue - - the default value.

Method Detail

getCategory

public OptionCategory getCategory()

getFieldName

public java.lang.String getFieldName()

getLabel

public java.lang.String getLabel()

get

public T get()

set

public void set(T value)

getDefaultValue

public T getDefaultValue()

getSortOrder

public int getSortOrder()

setSortOrder

public Option<T> setSortOrder(int sortOrder)

Used for sorting in the options pane.

Parameters:

sortOrder - the sort order.