Module net.minestom.server

Package net.minestom.server.component

Interface DataComponentMap

All Superinterfaces:

DataComponent.Holder

@Experimental
public sealed interface DataComponentMap
extends DataComponent.Holder

Represents any container of DataComponents.

This type is capable of storing a patch of added and removed components on top of a 'prototype', or existing set of components. See diff(DataComponentMap, DataComponentMap).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DataComponentMap.Builder
static interface	DataComponentMap.PatchBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final DataComponentMap	EMPTY

Method Summary

Modifier and Type	Method	Description
static DataComponentMap.Builder	builder()
static Codec<DataComponentMap>	codec(IntFunction<DataComponent<?>> idToType, Function<String,DataComponent<?>> nameToType)	Creates a network type for the given component type.
static DataComponentMap	diff(DataComponentMap prototype, DataComponentMap patch)
Collection<DataComponent.Value>	entrySet()
<T> T	get(DataComponentMap prototype, DataComponent<T> component)	Does a 'patch'ed get against the given prototype.
boolean	has(DataComponentMap prototype, DataComponent<?> component)	Does a 'patch'ed has against the given prototype.
boolean	isEmpty()
static NetworkBuffer.Type<DataComponentMap>	networkType(IntFunction<DataComponent<?>> idToType)
static DataComponentMap.PatchBuilder	patchBuilder()
static Codec<DataComponentMap>	patchCodec(IntFunction<DataComponent<?>> idToType, Function<String,DataComponent<?>> nameToType)	Creates a network type for the given component type.
static NetworkBuffer.Type<DataComponentMap>	patchNetworkType(IntFunction<DataComponent<?>> idToType, boolean trusted)	Creates a network type for the given component type.
DataComponentMap	remove(DataComponent<?> component)	Removes the component from the map (or patch).
default DataComponentMap	set(DataComponent<Unit> component)
<T> DataComponentMap	set(DataComponent<T> component, T value)	Adds the component, overwriting any prior value if present.
DataComponentMap.Builder	toBuilder()
DataComponentMap.PatchBuilder	toPatchBuilder()

Methods inherited from interface net.minestom.server.component.DataComponent.Holder

get, get, has

Field Details

EMPTY

static final DataComponentMap EMPTY

Method Details

builder

static DataComponentMap.Builder builder()

patchBuilder

static DataComponentMap.PatchBuilder patchBuilder()

networkType

@Internal
static NetworkBuffer.Type<DataComponentMap> networkType(IntFunction<DataComponent<?>> idToType)

codec

@Internal
static Codec<DataComponentMap> codec(IntFunction<DataComponent<?>> idToType,
 Function<String,DataComponent<?>> nameToType)

Creates a network type for the given component type. For internal use only, get the value from the target component class.

patchNetworkType

@Internal
static NetworkBuffer.Type<DataComponentMap> patchNetworkType(IntFunction<DataComponent<?>> idToType,
 boolean trusted)

Creates a network type for the given component type. For internal use only, get the value from the target component class.

patchCodec

@Internal
static Codec<DataComponentMap> patchCodec(IntFunction<DataComponent<?>> idToType,
 Function<String,DataComponent<?>> nameToType)

Creates a network type for the given component type. For internal use only, get the value from the target component class.

diff

static DataComponentMap diff(DataComponentMap prototype,
 DataComponentMap patch)

isEmpty

boolean isEmpty()

has

boolean has(DataComponentMap prototype,
 DataComponent<?> component)

Does a 'patch'ed has against the given prototype. That is, this map is treated as the primary source, but if unspecified, the given prototype is used as a fallback.

Parameters:

prototype - The prototype to fall back to

component - The component to check

Returns:

True if the component is present (taking into account the prototype).

get

@Nullable
<T> T get(DataComponentMap prototype,
 DataComponent<T> component)

Does a 'patch'ed get against the given prototype. That is, this map is treated as the primary source, but if unspecified, the given prototype is used as a fallback.

Type Parameters:

T - The type of the component

Parameters:

prototype - The prototype to fall back to

component - The component to get

Returns:

The value of the component, or null if not present (taking into account the prototype).

set

<T> DataComponentMap set(DataComponent<T> component,
 T value)

Adds the component, overwriting any prior value if present.

Returns:

A new map with the component set to the value

set

default DataComponentMap set(DataComponent<Unit> component)

remove

DataComponentMap remove(DataComponent<?> component)

Removes the component from the map (or patch).

Parameters:

component - The component to remove

Returns:

A new map with the component removed

entrySet

Collection<DataComponent.Value> entrySet()

toBuilder

DataComponentMap.Builder toBuilder()

toPatchBuilder

DataComponentMap.PatchBuilder toPatchBuilder()