Package com.seibel.distanthorizons.api.objects.config

Class DhApiConfigValue<coreType,apiType>

java.lang.Object

com.seibel.distanthorizons.api.objects.config.DhApiConfigValue<coreType,apiType>

Type Parameters:

coreType - The datatype Distant Horizons uses in the background; implementing developers can ignore this.

apiType - The datatype you, an API dev will use.

All Implemented Interfaces:

IDhApiConfigValue<apiType>

public class DhApiConfigValue<coreType,apiType>
extends Object
implements IDhApiConfigValue<apiType>

A wrapper used to interface with Distant Horizon's Config.

When using this object you need to explicitly define the generic types, otherwise Intellij won't do any type checking and the wrong types can be used.
For example a method returning IDhApiConfig<Integer> when the config should be a Boolean.

Since:

API 1.0.0

Constructor Summary

Constructors

Constructor	Description
DhApiConfigValue(IConfigEntry<coreType> newConfigEntry)	This constructor should only be called internally.
DhApiConfigValue(IConfigEntry<coreType> newConfigEntry, IConverter<coreType,apiType> newConverter)	This constructor should only be called internally.

Method Summary

Modifier and Type	Method	Description
void	addChangeListener(Consumer<apiType> onValueChangeFunc)	Adds a Consumer that will be called whenever the config changes to a new value.
boolean	clearValue()	Un-sets the config's API value.
apiType	getApiValue()	Returns the value of the config if it was set by the API.
boolean	getCanBeOverrodeByApi()
apiType	getDefaultValue()	Returns the default value for this config.
apiType	getMaxValue()	Returns the max value for this config, null if there is no max.
apiType	getMinValue()	Returns the min value for this config, null if there is no min.
apiType	getTrueValue()	Returns the value held by this config.
apiType	getValue()	Returns the active value for this config.
boolean	setValue(apiType newValue)	Sets the config's value.

Methods inherited from class java.lang.Object

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

Constructor Details

DhApiConfigValue

public DhApiConfigValue(IConfigEntry<coreType> newConfigEntry)

This constructor should only be called internally.
There is no reason for API users to create this object.

Uses the default object converter, this requires coreType and apiType to be the same.

DhApiConfigValue

public DhApiConfigValue(IConfigEntry<coreType> newConfigEntry,
 IConverter<coreType,apiType> newConverter)

This constructor should only be called internally.
There is no reason for API users to create this object.

Method Details

getValue

public apiType getValue()

Description copied from interface: IDhApiConfigValue

Returns the active value for this config.
Returns the True value if either the config cannot be overridden by the API or if it hasn't been set by the API.

Specified by:

getValue in interface IDhApiConfigValue<coreType>

getTrueValue

public apiType getTrueValue()

Description copied from interface: IDhApiConfigValue

Returns the value held by this config.
This is the value stored in the config file.

Specified by:

getTrueValue in interface IDhApiConfigValue<coreType>

getApiValue

public apiType getApiValue()

Description copied from interface: IDhApiConfigValue

Returns the value of the config if it was set by the API. Returns null if the config hasn't been set by the API.

Specified by:

getApiValue in interface IDhApiConfigValue<coreType>

setValue

public boolean setValue(apiType newValue)

Description copied from interface: IDhApiConfigValue

Sets the config's value.
If the newValue is set to null then the config will revert to using the True Value (IE the value visible in the config menu).
If the config cannot be set via the API this method will return false.

Specified by:

setValue in interface IDhApiConfigValue<coreType>

Returns:

true if the value was set, false otherwise.

clearValue

public boolean clearValue()

Description copied from interface: IDhApiConfigValue

Un-sets the config's API value.
After this method is called this config will use the value set in the config menu.

Specified by:

clearValue in interface IDhApiConfigValue<coreType>

Returns:

true if the value was set, false otherwise.

getCanBeOverrodeByApi

public boolean getCanBeOverrodeByApi()

Specified by:

getCanBeOverrodeByApi in interface IDhApiConfigValue<coreType>

Returns:

true if this config can be set via the API, false otherwise.

getDefaultValue

public apiType getDefaultValue()

Description copied from interface: IDhApiConfigValue

Returns the default value for this config.

Specified by:

getDefaultValue in interface IDhApiConfigValue<coreType>

getMaxValue

public apiType getMaxValue()

Description copied from interface: IDhApiConfigValue

Returns the max value for this config, null if there is no max.

Specified by:

getMaxValue in interface IDhApiConfigValue<coreType>

getMinValue

public apiType getMinValue()

Description copied from interface: IDhApiConfigValue

Returns the min value for this config, null if there is no min.

Specified by:

getMinValue in interface IDhApiConfigValue<coreType>

addChangeListener

public void addChangeListener(Consumer<apiType> onValueChangeFunc)

Description copied from interface: IDhApiConfigValue

Adds a Consumer that will be called whenever the config changes to a new value.

Specified by:

addChangeListener in interface IDhApiConfigValue<coreType>