Package codechicken.lib.config

Class ConfigCategoryImpl

java.lang.Object

codechicken.lib.config.AbstractConfigTag<ConfigCategory>

codechicken.lib.config.ConfigCategoryImpl

All Implemented Interfaces:

ConfigCategory, ConfigTag

public class ConfigCategoryImpl
extends AbstractConfigTag<ConfigCategory>
implements ConfigCategory

Created by covers1624 on 17/4/22.

Field Summary

Fields inherited from class codechicken.lib.config.AbstractConfigTag

comment, dirty, networkSynthetic, syncToClient

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes all children from this tag.
void	clearDirty()
ConfigCategoryImpl	copy(@Nullable ConfigCategoryImpl parent)
ConfigCategory	delete(String name)	Deletes the tag with the given name.
@Nullable ConfigCategoryImpl	findCategory(String name)	Gets the ConfigCategory with the given name, or null.
@Nullable AbstractConfigTag<?>	findTag(String name)	Gets the ConfigTag with the given name, or null.
@Nullable ConfigValueImpl	findValue(String name)	Gets the ConfigValue with the given name, or null.
@Nullable ConfigValueListImpl	findValueList(String name)	Gets the ConfigValueList with the given name, or null.
ConfigCategoryImpl	getCategory(String name)	Gets or creates a ConfigCategory with the given name.
Collection<ConfigTag>	getChildren()	Gets all child tags contained in this Category.
ConfigValueImpl	getValue(String name)	Gets or creates a ConfigValue with the given name.
ConfigValueListImpl	getValueList(String name)	Gets or creates a ConfigValueList with the given name.
boolean	has(String name)	Checks if this tag has a child with the given name.
boolean	isDirty()	If this ConfigTag or any of its children are dirty and requires flushing to disk.
void	read(MCDataInput in)	Read this tag from a MCDataInput.
boolean	requiresClientSync()	Checks if this tag or any of its children require client sync.
void	reset()	Reset this tag back to the default.
void	resetFromNetwork()	Resets all network tags back to their original value.
void	runSync(ConfigCallback.Reason reason)	Triggers all registered ConfigCallback's in the tree with the specified reason.
ConfigCategory	syncTagToClient()	Sets this tag as requiring syncing to the client.
void	write(MCDataOutput out)	Write this tag to a MCDataOutput.

Methods inherited from class codechicken.lib.config.AbstractConfigTag

copy, getComment, getName, getParent, isNetworkTag, onSync, setComment, setComment, setComment

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.ConfigCategory

onSync, setComment, setComment, setComment

Methods inherited from interface codechicken.lib.config.ConfigTag

copy, delete, forceSync, getComment, getDesc, getName, getParent, isNetworkTag, save

Constructor Details

ConfigCategoryImpl

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

Method Details

has

public boolean has(String name)

Description copied from interface: ConfigCategory

Checks if this tag has a child with the given name.

Specified by:

has in interface ConfigCategory

Parameters:

name - The name.

Returns:

If the child exists.

findTag

@Nullable
public @Nullable AbstractConfigTag<?> findTag(String name)

Description copied from interface: ConfigCategory

Gets the ConfigTag with the given name, or null.

Specified by:

findTag in interface ConfigCategory

Parameters:

name - The name.

Returns:

The ConfigTag or null if it doesn't exist.

getCategory

public ConfigCategoryImpl getCategory(String name)

Description copied from interface: ConfigCategory

Gets or creates a ConfigCategory with the given name.

Specified by:

getCategory in interface ConfigCategory

Parameters:

name - The name.

Returns:

The ConfigCategory.

findCategory

@Nullable
public @Nullable ConfigCategoryImpl findCategory(String name)

Description copied from interface: ConfigCategory

Gets the ConfigCategory with the given name, or null.

This will return null if the ConfigTag at the name is not a ConfigCategory or it does not exist.

Specified by:

findCategory in interface ConfigCategory

Parameters:

name - The name.

Returns:

The ConfigCategory or null.

getValue

public ConfigValueImpl getValue(String name)

Description copied from interface: ConfigCategory

Gets or creates a ConfigValue with the given name.

Specified by:

getValue in interface ConfigCategory

Parameters:

name - The name.

Returns:

The ConfigValue.

findValue

@Nullable
public @Nullable ConfigValueImpl findValue(String name)

Description copied from interface: ConfigCategory

Gets the ConfigValue with the given name, or null.

This will return null if the ConfigTag at the name is not a ConfigValue or it does not exist.

Specified by:

findValue in interface ConfigCategory

Parameters:

name - The name.

Returns:

The ConfigValue or null

getValueList

public ConfigValueListImpl getValueList(String name)

Description copied from interface: ConfigCategory

Gets or creates a ConfigValueList with the given name.

Specified by:

getValueList in interface ConfigCategory

Parameters:

name - The name.

Returns:

The ConfigValueList.

findValueList

@Nullable
public @Nullable ConfigValueListImpl findValueList(String name)

Description copied from interface: ConfigCategory

Gets the ConfigValueList with the given name, or null.

This will return null if the ConfigTag at the name is not a ConfigValueList or it does not exist.

Specified by:

findValueList in interface ConfigCategory

Parameters:

name - The name.

Returns:

The ConfigValueList or null

getChildren

public Collection<ConfigTag> getChildren()

Description copied from interface: ConfigCategory

Gets all child tags contained in this Category.

Specified by:

getChildren in interface ConfigCategory

Returns:

All the child tags.

delete

public ConfigCategory delete(String name)

Description copied from interface: ConfigCategory

Deletes the tag with the given name.

If the tag does not exist, this method does nothing.

Specified by:

delete in interface ConfigCategory

Parameters:

name - The name of the tag to delete.

Returns:

The same config tag.

clear

public void clear()

Description copied from interface: ConfigCategory

Removes all children from this tag.

Specified by:

clear in interface ConfigCategory

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

syncTagToClient

public ConfigCategory syncTagToClient()

Description copied from interface: ConfigTag

Sets this tag as requiring syncing to the client.

Register your root tag via ConfigSyncManager.registerSync(ResourceLocation, ConfigTag).

Specified by:

syncTagToClient in interface ConfigCategory

Specified by:

syncTagToClient in interface ConfigTag

Overrides:

syncTagToClient in class AbstractConfigTag<ConfigCategory>

requiresClientSync

public boolean requiresClientSync()

Description copied from interface: ConfigTag

Checks if this tag or any of its children require client sync.

Specified by:

requiresClientSync in interface ConfigTag

Overrides:

requiresClientSync in class AbstractConfigTag<ConfigCategory>

Returns:

If client sync is required.

runSync

public void runSync(ConfigCallback.Reason reason)

Description copied from interface: ConfigTag

Triggers all registered ConfigCallback's in the tree with the specified reason.

This method should probably not be called by anyone else.

Specified by:

runSync in interface ConfigTag

Overrides:

runSync in class AbstractConfigTag<ConfigCategory>

Parameters:

reason - The reason.

isDirty

public boolean isDirty()

Description copied from interface: ConfigTag

If this ConfigTag or any of its children are dirty and requires flushing to disk.

Specified by:

isDirty in interface ConfigTag

Overrides:

isDirty in class AbstractConfigTag<ConfigCategory>

Returns:

If the branch is dirty.

clearDirty

public void clearDirty()

Overrides:

clearDirty in class AbstractConfigTag<ConfigCategory>

copy

public ConfigCategoryImpl copy(@Nullable
 @Nullable ConfigCategoryImpl parent)

Specified by:

copy in class AbstractConfigTag<ConfigCategory>

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