Package codechicken.lib.config

Class ConfigValueListImpl

java.lang.Object

codechicken.lib.config.AbstractConfigTag<ConfigValueList>

codechicken.lib.config.ConfigValueListImpl

All Implemented Interfaces:

ConfigTag, ConfigValueList

public class ConfigValueListImpl
extends AbstractConfigTag<ConfigValueList>
implements ConfigValueList

TODO do we want to explode if someone tires to set a value when it is set from the network? Created by covers1624 on 19/4/22.

Field Summary

Fields inherited from class codechicken.lib.config.AbstractConfigTag

comment, dirty, networkSynthetic, syncToClient

Constructor Summary

Constructors

Constructor	Description
ConfigValueListImpl(String name, @Nullable ConfigCategoryImpl parent)

Method Summary

Modifier and Type	Method	Description
AbstractConfigTag<ConfigValueList>	copy(@Nullable ConfigCategoryImpl parent)
it.unimi.dsi.fastutil.booleans.BooleanList	getBooleans()	Gets the BooleanList values stored in this tag.
it.unimi.dsi.fastutil.booleans.BooleanList	getDefaultBooleans()	Gets the default BooleanList values stored in this tag.
it.unimi.dsi.fastutil.doubles.DoubleList	getDefaultDoubles()	Gets the default DoubleList values stored in this tag.
it.unimi.dsi.fastutil.ints.IntList	getDefaultHexs()	Gets the default IntList values represented as Hex strings stored in this tag.
it.unimi.dsi.fastutil.ints.IntList	getDefaultInts()	Gets the default IntList values stored in this tag.
it.unimi.dsi.fastutil.longs.LongList	getDefaultLongs()	Gets the default LongList values stored in this tag.
List<String>	getDefaultStrings()	Gets the default List of String values stored in this tag.
it.unimi.dsi.fastutil.doubles.DoubleList	getDoubles()	Gets the DoubleList values stored in this tag.
it.unimi.dsi.fastutil.ints.IntList	getHexs()	Gets the IntList values stored as a Hex strings stored in this tag.
it.unimi.dsi.fastutil.ints.IntList	getInts()	Gets the IntList values stored in this tag.
it.unimi.dsi.fastutil.longs.LongList	getLongs()	Gets the LongList value stored in this tag.
List<?>	getRawValue()
@Nullable ListRestriction	getRestriction()	Gets the Restriction predicate for this tag.
List<String>	getStrings()	Gets the List of String values stored in this tag.
ValueType	getType()	Gets the type of the ConfigValueList.
void	read(MCDataInput in)	Read this tag from a MCDataInput.
void	reset()	Reset this tag back to the default.
void	resetFromNetwork()	Resets all network tags back to their original value.
ConfigValueList	setBooleans(List<Boolean> values)	Sets the List of Boolean values stored in this tag.
ConfigValueList	setDefaultBooleans(List<Boolean> values)	Sets the default List of Boolean values stored in this tag.
ConfigValueList	setDefaultDoubles(List<Double> values)	Sets the default List of Double values stored in this tag.
ConfigValueList	setDefaultHexs(List<Integer> values)	Sets the default List of Integer values represented as hex Strings stored in this tag.
ConfigValueList	setDefaultInts(List<Integer> values)	Sets the default List of Integer values stored in this tag.
ConfigValueList	setDefaultLongs(List<Long> values)	Sets the default List of Long values stored in this tag.
ConfigValueList	setDefaultStrings(List<String> values)	Sets the default List of String values stored in this tag.
ConfigValueList	setDefaultValue(List<?> value)
ConfigValueList	setDoubles(List<Double> values)	Sets the List of Double values stored in this tag.
ConfigValueList	setHexs(List<Integer> values)	Sets the List of Integer values represented as hex Strings stored in this tag.
ConfigValueList	setInts(List<Integer> values)	Sets the List of Integer values stored in this tag.
void	setKnownType(ValueType type)
ConfigValueList	setLongs(List<Long> values)	Sets the List of Long values stored in this tag.
ConfigValueList	setRestriction(ListRestriction restriction)	// TODO Improve wording for lists.
ConfigValueList	setStrings(List<String> values)	Sets the List of String values stored in this tag.
ConfigValueList	setValue(List<?> value)
void	write(MCDataOutput out)	Write this tag to a MCDataOutput.

Methods inherited from class codechicken.lib.config.AbstractConfigTag

clearDirty, copy, getComment, getName, getParent, isDirty, isNetworkTag, onSync, requiresClientSync, runSync, setComment, setComment, setComment, syncTagToClient

Methods inherited from class java.lang.Object

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

Methods inherited from interface codechicken.lib.config.ConfigTag

copy, delete, forceSync, getComment, getDesc, getName, getParent, isDirty, isNetworkTag, requiresClientSync, runSync, save

Methods inherited from interface codechicken.lib.config.ConfigValueList

onSync, setComment, setComment, setComment, syncTagToClient

Constructor Details

ConfigValueListImpl

public ConfigValueListImpl(String name,
 @Nullable
 @Nullable ConfigCategoryImpl parent)

Method Details

getType

public ValueType getType()

Description copied from interface: ConfigValueList

Gets the type of the ConfigValueList.

Specified by:

getType in interface ConfigValueList

Returns:

The ValueType of this tag.

getBooleans

public it.unimi.dsi.fastutil.booleans.BooleanList getBooleans()

Description copied from interface: ConfigValueList

Gets the BooleanList values stored in this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Specified by:

getBooleans in interface ConfigValueList

Returns:

The boolean value or the default.

getStrings

public List<String> getStrings()

Description copied from interface: ConfigValueList

Gets the List of String values stored in this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Specified by:

getStrings in interface ConfigValueList

Returns:

The String value or the default.

getInts

public it.unimi.dsi.fastutil.ints.IntList getInts()

Description copied from interface: ConfigValueList

Gets the IntList values stored in this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Specified by:

getInts in interface ConfigValueList

Returns:

The int value or the default.

getLongs

public it.unimi.dsi.fastutil.longs.LongList getLongs()

Description copied from interface: ConfigValueList

Gets the LongList value stored in this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Specified by:

getLongs in interface ConfigValueList

Returns:

The long value or the default.

getHexs

public it.unimi.dsi.fastutil.ints.IntList getHexs()

Description copied from interface: ConfigValueList

Gets the IntList values stored as a Hex strings stored in this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Specified by:

getHexs in interface ConfigValueList

Returns:

The int value or the default.

getDoubles

public it.unimi.dsi.fastutil.doubles.DoubleList getDoubles()

Description copied from interface: ConfigValueList

Gets the DoubleList values stored in this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Specified by:

getDoubles in interface ConfigValueList

Returns:

The double value or the default.

setBooleans

public ConfigValueList setBooleans(List<Boolean> values)

Description copied from interface: ConfigValueList

Sets the List of Boolean values stored in this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Specified by:

setBooleans in interface ConfigValueList

Parameters:

values - The List of Boolean values.

Returns:

The same ConfigValueList.

setStrings

public ConfigValueList setStrings(List<String> values)

Description copied from interface: ConfigValueList

Sets the List of String values stored in this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Specified by:

setStrings in interface ConfigValueList

Parameters:

values - The List of String values.

Returns:

The same ConfigValueList.

setInts

public ConfigValueList setInts(List<Integer> values)

Description copied from interface: ConfigValueList

Sets the List of Integer values stored in this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Specified by:

setInts in interface ConfigValueList

Parameters:

values - The List of Integer values.

Returns:

The same ConfigValueList.

setLongs

public ConfigValueList setLongs(List<Long> values)

Description copied from interface: ConfigValueList

Sets the List of Long values stored in this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Specified by:

setLongs in interface ConfigValueList

Parameters:

values - The List of Long values.

Returns:

The same ConfigValueList.

setHexs

public ConfigValueList setHexs(List<Integer> values)

Description copied from interface: ConfigValueList

Sets the List of Integer values represented as hex Strings stored in this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Specified by:

setHexs in interface ConfigValueList

Parameters:

values - The List of Integer values.

Returns:

The same ConfigValueList.

setDoubles

public ConfigValueList setDoubles(List<Double> values)

Description copied from interface: ConfigValueList

Sets the List of Double values stored in this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Specified by:

setDoubles in interface ConfigValueList

Parameters:

values - The List of Double values.

Returns:

The same ConfigValueList.

getDefaultBooleans

public it.unimi.dsi.fastutil.booleans.BooleanList getDefaultBooleans()

Description copied from interface: ConfigValueList

Gets the default BooleanList values stored in this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Specified by:

getDefaultBooleans in interface ConfigValueList

Returns:

The default BooleanList values.

getDefaultStrings

public List<String> getDefaultStrings()

Description copied from interface: ConfigValueList

Gets the default List of String values stored in this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Specified by:

getDefaultStrings in interface ConfigValueList

Returns:

The default List of String values.

getDefaultInts

public it.unimi.dsi.fastutil.ints.IntList getDefaultInts()

Description copied from interface: ConfigValueList

Gets the default IntList values stored in this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Specified by:

getDefaultInts in interface ConfigValueList

Returns:

The default LongList values.

getDefaultLongs

public it.unimi.dsi.fastutil.longs.LongList getDefaultLongs()

Description copied from interface: ConfigValueList

Gets the default LongList values stored in this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Specified by:

getDefaultLongs in interface ConfigValueList

Returns:

The default LongList values.

getDefaultHexs

public it.unimi.dsi.fastutil.ints.IntList getDefaultHexs()

Description copied from interface: ConfigValueList

Gets the default IntList values represented as Hex strings stored in this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Specified by:

getDefaultHexs in interface ConfigValueList

Returns:

The default IntList values.

getDefaultDoubles

public it.unimi.dsi.fastutil.doubles.DoubleList getDefaultDoubles()

Description copied from interface: ConfigValueList

Gets the default DoubleList values stored in this tag.

No attempt to convert between tag types is made, this must be called on a tag which has a non ValueType.UNKNOWN type.

Specified by:

getDefaultDoubles in interface ConfigValueList

Returns:

The default DoubleList values.

setDefaultBooleans

public ConfigValueList setDefaultBooleans(List<Boolean> values)

Description copied from interface: ConfigValueList

Sets the default List of Boolean values stored in this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Specified by:

setDefaultBooleans in interface ConfigValueList

Parameters:

values - The List of Boolean values.

Returns:

The same ConfigValueList.

setDefaultStrings

public ConfigValueList setDefaultStrings(List<String> values)

Description copied from interface: ConfigValueList

Sets the default List of String values stored in this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Specified by:

setDefaultStrings in interface ConfigValueList

Parameters:

values - The List of String values.

Returns:

The same ConfigValueList.

setDefaultInts

public ConfigValueList setDefaultInts(List<Integer> values)

Description copied from interface: ConfigValueList

Sets the default List of Integer values stored in this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Specified by:

setDefaultInts in interface ConfigValueList

Parameters:

values - The List of Integer values.

Returns:

The same ConfigValueList.

setDefaultLongs

public ConfigValueList setDefaultLongs(List<Long> values)

Description copied from interface: ConfigValueList

Sets the default List of Long values stored in this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Specified by:

setDefaultLongs in interface ConfigValueList

Parameters:

values - The List of Long values.

Returns:

The same ConfigValueList.

setDefaultHexs

public ConfigValueList setDefaultHexs(List<Integer> values)

Description copied from interface: ConfigValueList

Sets the default List of Integer values represented as hex Strings stored in this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Specified by:

setDefaultHexs in interface ConfigValueList

Parameters:

values - The List of Integer values.

Returns:

The same ConfigValueList.

setDefaultDoubles

public ConfigValueList setDefaultDoubles(List<Double> values)

Description copied from interface: ConfigValueList

Sets the default List of Double values stored in this tag.

If the tag has an ValueType.UNKNOWN value type, this function will set it appropriately.

Specified by:

setDefaultDoubles in interface ConfigValueList

Parameters:

values - The List of Double values.

Returns:

The same ConfigValueList.

setRestriction

public ConfigValueList setRestriction(ListRestriction restriction)

Description copied from interface: ConfigValueList

// TODO Improve wording for lists. Set the Restriction for this ConfigValueList.

A restriction is just a Predicate, and can be used for anything, but is most commonly used for int/float value ranges on tags.

If the restriction is violated, either by the tag being loaded from disk, or via a set method, it will be reset to default.

TODO, in the future, provide a function to choose what to do when a value is invalid, allow the value to be altered (clamped), removed, or reset entirely to default.

It is invalid for the restriction to not accept the tag's default value, if the restriction does not, it will throw an IllegalArgumentException either when the restriction is set, or the default is set, whichever comes last.

See Restriction for more information.

Specified by:

setRestriction in interface ConfigValueList

Parameters:

restriction - The restriction to set.

Returns:

The same ConfigValueList.

See Also:

• Restriction

getRestriction

@Nullable
public @Nullable ListRestriction getRestriction()

Description copied from interface: ConfigValueList

Gets the Restriction predicate for this tag.

Specified by:

getRestriction in interface ConfigValueList

Returns:

The Restriction

reset

public void reset()

Description copied from interface: ConfigTag

Reset this tag back to the default.

In the event that this is a ConfigCategory sets all descendant values to their default.

Specified by:

reset in interface ConfigTag

copy

public AbstractConfigTag<ConfigValueList> copy(@Nullable
 @Nullable ConfigCategoryImpl parent)

Specified by:

copy in class AbstractConfigTag<ConfigValueList>

write

public void write(MCDataOutput out)

Description copied from interface: ConfigTag

Write this tag to a MCDataOutput. Only categories and/or tags which have ConfigTag.syncTagToClient() set will be written.

Specified by:

write in interface ConfigTag

Parameters:

out - The output stream.

read

public void read(MCDataInput in)

Description copied from interface: ConfigTag

Read this tag from a MCDataInput. All tags and values will be read and inserted into the tree.

If a tag does not already exist in the tree, one will be added and marked as a 'network tag', ConfigTag.isNetworkTag().

All tags with a network value will be reset to default when ConfigTag.resetFromNetwork() is called, whilst any 'network only' tags will be deleted.

Specified by:

read in interface ConfigTag

Parameters:

in - The input stream.

resetFromNetwork

public void resetFromNetwork()

Description copied from interface: ConfigTag

Resets all network tags back to their original value.

Whilst a tag is set from the network, it is effectively immutable and may not be set.

Any tags which are 'network only' are deleted during this operation.

Specified by:

resetFromNetwork in interface ConfigTag

setValue

public ConfigValueList setValue(List<?> value)

getRawValue

public List<?> getRawValue()

setDefaultValue

public ConfigValueList setDefaultValue(List<?> value)

setKnownType

public void setKnownType(ValueType type)