Package org.geysermc.mcprotocollib.protocol.data.game.item.component

Class DataComponents

java.lang.Object

org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponents

public class DataComponents
extends Object

Wrapper around a map of data components and their respective values.

This map can either be a complete data component map, or a data component patch to another map. The meaning of null values in the map depends on if the map is a patch or full map. If the map:

• Is a full map, null means an absence of the component in the map. put(DataComponentType, Object) should not be used with null values, rather remove(DataComponentType) should be used.
• Is a patch, null can mean an absence of the component in the patch, or that the component should be removed from a map the patch is applied to. Use contains(DataComponentType), which returns true for the latter, to check which is the case.

Make sure to initialise this class with a map that accepts null values if representing a patch.

Constructor Summary

Constructors

Constructor	Description
DataComponents(Map<DataComponentType<?>,DataComponent<?,?>> dataComponents)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(@Nullable Object other)
DataComponents	clone()
boolean	contains(DataComponentType<?> component)
boolean	equals(@Nullable Object o)
<T> T	get(DataComponentType<T> type)
Map<DataComponentType<?>,DataComponent<?,?>>	getDataComponents()
<T> T	getOrDefault(DataComponentType<T> type, T def)
int	hashCode()
<T> void	put(DataComponentType<T> type, T value)
<T> T	remove(DataComponentType<T> component)
@NonNull String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DataComponents

public DataComponents(Map<DataComponentType<?>,DataComponent<?,?>> dataComponents)

Method Details

get

@Nullable
public <T> T get(DataComponentType<T> type)

getOrDefault

public <T> T getOrDefault(DataComponentType<T> type,
 T def)

put

public <T> void put(DataComponentType<T> type,
 @Nullable
 T value)

Parameters:

value - should only be null if this map is a patch to another map and specifying the removal of the specific component.

contains

public boolean contains(DataComponentType<?> component)

remove

@Nullable
public <T> T remove(DataComponentType<T> component)

clone

public DataComponents clone()

Overrides:

clone in class Object

getDataComponents

public Map<DataComponentType<?>,DataComponent<?,?>> getDataComponents()

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(@Nullable Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public @NonNull String toString()

Overrides:

toString in class Object