com.mojang.serialization

Interface Keyable

All Known Subinterfaces:

Compressable, MapDecoder<A>, MapEncoder<A>

All Known Implementing Classes:

CompressorHolder, EitherMapCodec, FieldDecoder, FieldEncoder, KeyDispatchCodec, MapCodec, MapDecoder.Implementation, MapEncoder.Implementation, OptionalFieldCodec, PairMapCodec, SimpleMapCodec

public interface Keyable

A definer or acceptor of serialized keys.

Types implementing this interface define a set of valid keys. Typically, these keys are serialized to or extracted from some serialized object.

See Also:

MapCodec

Method Summary

Modifier and Type	Method and Description
static Keyable	forStrings(by-name Stream<String> keys) Returns a Keyable that defines the keys supplied by the argument.
<T> Stream<T>	keys(DynamicOps<T> ops) Returns the set of keys this object defines or accepts, serialized to the provided form.

Method Detail

keys

<T> Stream<T> keys(DynamicOps<T> ops)

Returns the set of keys this object defines or accepts, serialized to the provided form.

Implementation Requirements:

The returned stream should be finite and provide distinct elements. The stream, furthermore, should not already be consumed (that is, a new stream should be created each time this method is called).

Type Parameters:

T - The type of the serialized form.

Parameters:

ops - The DynamicOps instance defining the serialized form.

Returns:

The set of keys this object defines.

forStrings

static Keyable forStrings(by-name Stream<String> keys)

Returns a Keyable that defines the keys supplied by the argument.

The supplier must return a fresh stream on each invocation. As well, care should be taken that the source backing the returned stream is not modified or otherwise invalidated, because the returned Keyable does not store a local copy of the keys. The caller is responsible for making a defensive copy of the backing source, if one is required.

Parameters:

keys - A supplier of key streams. A fresh stream should be returned on each invocation.

Returns:

A Keyable for the given keys.