All Superinterfaces:: Decoder<A>, Encoder<A>

All Known Subinterfaces:: PrimitiveCodec<A>

All Known Implementing Classes:: Codec.RecursiveCodec, CompoundListCodec, DispatchedMapCodec, EitherCodec, ExtraCodecs.StrictUnboundedMapCodec, HolderSetCodec, LenientUnboundedMapCodec, ListCodec, MapCodec.MapCodecCodec, NeoForgeExtraCodecs.AlternativeCodec, PairCodec, RegistryFileCodec, RegistryFixedCodec, StringRepresentable.EnumCodec, StringRepresentable.StringRepresentableCodec, UnboundedMapCodec, XorCodec

public interface Codec<A> extends Encoder<A>, Decoder<A>

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static class

Codec.RecursiveCodec<T>

static interface

Codec.ResultFunction<A>

Nested classes/interfaces inherited from interface Decoder
Decoder.Boxed<A>, Decoder.Simple<A>, Decoder.Terminal<A>
Field Summary

Fields

Modifier and Type

Field

Description

static final PrimitiveCodec<Boolean>

BOOL

static final PrimitiveCodec<Byte>

BYTE

static final PrimitiveCodec<ByteBuffer>

BYTE_BUFFER

static final PrimitiveCodec<Double>

DOUBLE

static final MapCodec<Unit>

EMPTY

static final PrimitiveCodec<Float>

FLOAT

static final PrimitiveCodec<Integer>

INT

static final PrimitiveCodec<IntStream>

INT_STREAM

static final PrimitiveCodec<Long>

LONG

static final PrimitiveCodec<LongStream>

LONG_STREAM

static final Codec<Dynamic<?>>

PASSTHROUGH

static final PrimitiveCodec<Short>

SHORT

static final PrimitiveCodec<String>

STRING
Method Summary

Modifier and Type

Method

Description

static <N extends Number & Comparable<N>> Function<N, DataResult<N>>

checkRange(N minInclusive, N maxInclusive)

default <S> Codec<S>

comapFlatMap(Function<? super A, ? extends DataResult<? extends S>> to, Function<? super S, ? extends A> from)

static <K,V> Codec<List<Pair<K,V>>>

compoundList(Codec<K> keyCodec, Codec<V> elementCodec)

default Codec<A>

deprecated(int since)

default <E> Codec<E>

dispatch(String typeKey, Function<? super E, ? extends A> type, Function<? super A, ? extends MapCodec<? extends E>> codec)

default <E> Codec<E>

dispatch(Function<? super E, ? extends A> type, Function<? super A, ? extends MapCodec<? extends E>> codec)

static <K,V> Codec<Map<K,V>>

dispatchedMap(Codec<K> keyCodec, Function<K, Codec<? extends V>> valueCodecFunction)

default <E> MapCodec<E>

dispatchMap(String typeKey, Function<? super E, ? extends A> type, Function<? super A, ? extends MapCodec<? extends E>> codec)

default <E> MapCodec<E>

dispatchMap(Function<? super E, ? extends A> type, Function<? super A, ? extends MapCodec<? extends E>> codec)

default <E> Codec<E>

dispatchStable(Function<? super E, ? extends A> type, Function<? super A, ? extends MapCodec<? extends E>> codec)

static Codec<Double>

doubleRange(double minInclusive, double maxInclusive)

static <F,S> Codec<Either<F,S>>

either(Codec<F> first, Codec<S> second)

default MapCodec<A>

fieldOf(String name)

default <S> Codec<S>

flatComapMap(Function<? super A, ? extends S> to, Function<? super S, ? extends DataResult<? extends A>> from)

default <S> Codec<S>

flatXmap(Function<? super A, ? extends DataResult<? extends S>> to, Function<? super S, ? extends DataResult<? extends A>> from)

static Codec<Float>

floatRange(float minInclusive, float maxInclusive)

static Codec<Integer>

intRange(int minInclusive, int maxInclusive)

static <A> Codec<A>

lazyInitialized(Supplier<Codec<A>> delegate)

default MapCodec<Optional<A>>

lenientOptionalFieldOf(String name)

default MapCodec<A>

lenientOptionalFieldOf(String name, A defaultValue)

default MapCodec<A>

lenientOptionalFieldOf(String name, A defaultValue, Lifecycle lifecycleOfDefault)

default MapCodec<A>

lenientOptionalFieldOf(String name, Lifecycle fieldLifecycle, A defaultValue, Lifecycle lifecycleOfDefault)

static <E> Codec<List<E>>

list(Codec<E> elementCodec)

static <E> Codec<List<E>>

list(Codec<E> elementCodec, int minSize, int maxSize)

default Codec<List<A>>

listOf()

default Codec<List<A>>

listOf(int minSize, int maxSize)

static <F,S> MapCodec<Either<F,S>>

mapEither(MapCodec<F> first, MapCodec<S> second)

static <F,S> MapCodec<Pair<F,S>>

mapPair(MapCodec<F> first, MapCodec<S> second)

default Codec<A>

mapResult(Codec.ResultFunction<A> function)

static <A> Codec<A>

of(Encoder<A> encoder, Decoder<A> decoder)

static <A> Codec<A>

of(Encoder<A> encoder, Decoder<A> decoder, String name)

static <A> MapCodec<A>

of(MapEncoder<A> encoder, MapDecoder<A> decoder)

static <A> MapCodec<A>

of(MapEncoder<A> encoder, MapDecoder<A> decoder, Supplier<String> name)

static <F> MapCodec<Optional<F>>

optionalField(String name, Codec<F> elementCodec, boolean lenient)

default MapCodec<Optional<A>>

optionalFieldOf(String name)

default MapCodec<A>

optionalFieldOf(String name, A defaultValue)

private MapCodec<A>

optionalFieldOf(String name, A defaultValue, boolean lenient)

default MapCodec<A>

optionalFieldOf(String name, A defaultValue, Lifecycle lifecycleOfDefault)

default MapCodec<A>

optionalFieldOf(String name, Lifecycle fieldLifecycle, A defaultValue, Lifecycle lifecycleOfDefault)

private MapCodec<A>

optionalFieldOf(String name, Lifecycle fieldLifecycle, A defaultValue, Lifecycle lifecycleOfDefault, boolean lenient)

default Codec<A>

orElse(A value)

default Codec<A>

orElse(Consumer<String> onError, A value)

default Codec<A>

orElse(UnaryOperator<String> onError, A value)

default Codec<A>

orElseGet(Consumer<String> onError, Supplier<? extends A> value)

default Codec<A>

orElseGet(Supplier<? extends A> value)

default Codec<A>

orElseGet(UnaryOperator<String> onError, Supplier<? extends A> value)

static <F,S> Codec<Pair<F,S>>

pair(Codec<F> first, Codec<S> second)

default <E> Codec<E>

partialDispatch(String typeKey, Function<? super E, ? extends DataResult<? extends A>> type, Function<? super A, ? extends DataResult<? extends MapCodec<? extends E>>> codec)

default Codec<A>

promotePartial(Consumer<String> onError)

static <A> Codec<A>

recursive(String name, Function<Codec<A>,Codec<A>> wrapped)

static <K,V> SimpleMapCodec<K,V>

simpleMap(Codec<K> keyCodec, Codec<V> elementCodec, Keyable keys)

default Codec<List<A>>

sizeLimitedListOf(int maxSize)

static Codec<String>

sizeLimitedString(int maxSize)

default Codec<A>

stable()

static Codec<String>

string(int minSize, int maxSize)

static <E> Codec<E>

stringResolver(Function<E,String> toString, Function<String,E> fromString)

static <K,V> UnboundedMapCodec<K,V>

unboundedMap(Codec<K> keyCodec, Codec<V> elementCodec)

default Codec<A>

validate(Function<A, DataResult<A>> checker)

default Codec<A>

withAlternative(Codec<? extends A> alternative)

static <T> Codec<T>

withAlternative(Codec<T> primary, Codec<? extends T> alternative)

static <T,U> Codec<T>

withAlternative(Codec<T> primary, Codec alternative, Function<U,T> converter)

default Codec<A>

withAlternative(Codec alternative, Function<U,A> converter)

default Codec<A>

withLifecycle(Lifecycle lifecycle)

default <S> Codec<S>

xmap(Function<? super A, ? extends S> to, Function<? super S, ? extends A> from)

static <F,S> Codec<Either<F,S>>

xor(Codec<F> first, Codec<S> second)

Methods inherited from interface Decoder
boxed, decode, decode, flatMap, map, parse, parse, simple, terminal

Methods inherited from interface Encoder
comap, encode, encodeStart, flatComap

Field Details
- BOOL
 
 static final PrimitiveCodec<Boolean> BOOL
- BYTE
 
 static final PrimitiveCodec<Byte> BYTE
- SHORT
 
 static final PrimitiveCodec<Short> SHORT
- INT
 
 static final PrimitiveCodec<Integer> INT
- LONG
 
 static final PrimitiveCodec<Long> LONG
- FLOAT
 
 static final PrimitiveCodec<Float> FLOAT
- DOUBLE
 
 static final PrimitiveCodec<Double> DOUBLE
- STRING
 
 static final PrimitiveCodec<String> STRING
- BYTE_BUFFER
 
 static final PrimitiveCodec<ByteBuffer> BYTE_BUFFER
- INT_STREAM
 
 static final PrimitiveCodec<IntStream> INT_STREAM
- LONG_STREAM
 
 static final PrimitiveCodec<LongStream> LONG_STREAM
- PASSTHROUGH
 
 static final Codec<Dynamic<?>> PASSTHROUGH
- EMPTY
 
 static final MapCodec<Unit> EMPTY
Method Details
- withLifecycle
 
 default Codec<A> withLifecycle(Lifecycle lifecycle)
 
 Specified by:
 
 withLifecycle in interface Decoder<A>
 
 Specified by:
 
 withLifecycle in interface Encoder<A>
- stable
 
 default Codec<A> stable()
- deprecated
 
 default Codec<A> deprecated(int since)
- of
 
 static <A> Codec<A> of(Encoder<A> encoder, Decoder<A> decoder)
- of
 
 static <A> Codec<A> of(Encoder<A> encoder, Decoder<A> decoder, String name)
- of
 
 static <A> MapCodec<A> of(MapEncoder<A> encoder, MapDecoder<A> decoder)
- of
 
 static <A> MapCodec<A> of(MapEncoder<A> encoder, MapDecoder<A> decoder, Supplier<String> name)
- pair
 
 static <F,S> Codec<Pair<F,S>> pair(Codec<F> first, Codec<S> second)
- either
 
 static <F,S> Codec<Either<F,S>> either(Codec<F> first, Codec<S> second)
- xor
 
 static <F,S> Codec<Either<F,S>> xor(Codec<F> first, Codec<S> second)
- withAlternative
 
 static <T> Codec<T> withAlternative(Codec<T> primary, Codec<? extends T> alternative)
- withAlternative
 
 default Codec<A> withAlternative(Codec<? extends A> alternative)
- withAlternative
 
 static <T,U> Codec<T> withAlternative(Codec<T> primary, Codec alternative, Function<U,T> converter)
- withAlternative
 
 default Codec<A> withAlternative(Codec alternative, Function<U,A> converter)
- mapPair
 
 static <F,S> MapCodec<Pair<F,S>> mapPair(MapCodec<F> first, MapCodec<S> second)
- mapEither
 
 static <F,S> MapCodec<Either<F,S>> mapEither(MapCodec<F> first, MapCodec<S> second)
- list
 
 static <E> Codec<List<E>> list(Codec<E> elementCodec)
- list
 
 static <E> Codec<List<E>> list(Codec<E> elementCodec, int minSize, int maxSize)
- compoundList
 
 static <K,V> Codec<List<Pair<K,V>>> compoundList(Codec<K> keyCodec, Codec<V> elementCodec)
- simpleMap
 
 static <K,V> SimpleMapCodec<K,V> simpleMap(Codec<K> keyCodec, Codec<V> elementCodec, Keyable keys)
- unboundedMap
 
 static <K,V> UnboundedMapCodec<K,V> unboundedMap(Codec<K> keyCodec, Codec<V> elementCodec)
- dispatchedMap
 
 static <K,V> Codec<Map<K,V>> dispatchedMap(Codec<K> keyCodec, Function<K, Codec<? extends V>> valueCodecFunction)
- stringResolver
 
 static <E> Codec<E> stringResolver(Function<E,String> toString, Function<String,E> fromString)
- optionalField
 
 static <F> MapCodec<Optional<F>> optionalField(String name, Codec<F> elementCodec, boolean lenient)
- recursive
 
 static <A> Codec<A> recursive(String name, Function<Codec<A>,Codec<A>> wrapped)
- lazyInitialized
 
 static <A> Codec<A> lazyInitialized(Supplier<Codec<A>> delegate)
- listOf
 
 default Codec<List<A>> listOf()
- listOf
 
 default Codec<List<A>> listOf(int minSize, int maxSize)
- sizeLimitedListOf
 
 default Codec<List<A>> sizeLimitedListOf(int maxSize)
- xmap
 
 default <S> Codec<S> xmap(Function<? super A, ? extends S> to, Function<? super S, ? extends A> from)
- comapFlatMap
 
 default <S> Codec<S> comapFlatMap(Function<? super A, ? extends DataResult<? extends S>> to, Function<? super S, ? extends A> from)
- flatComapMap
 
 default <S> Codec<S> flatComapMap(Function<? super A, ? extends S> to, Function<? super S, ? extends DataResult<? extends A>> from)
- flatXmap
 
 default <S> Codec<S> flatXmap(Function<? super A, ? extends DataResult<? extends S>> to, Function<? super S, ? extends DataResult<? extends A>> from)
- fieldOf
 
 default MapCodec<A> fieldOf(String name)
 
 Specified by:
 
 fieldOf in interface Decoder<A>
 
 Specified by:
 
 fieldOf in interface Encoder<A>
- optionalFieldOf
 
 default MapCodec<Optional<A>> optionalFieldOf(String name)
- optionalFieldOf
 
 default MapCodec<A> optionalFieldOf(String name, A defaultValue)
- optionalFieldOf
 
 default MapCodec<A> optionalFieldOf(String name, A defaultValue, Lifecycle lifecycleOfDefault)
- optionalFieldOf
 
 default MapCodec<A> optionalFieldOf(String name, Lifecycle fieldLifecycle, A defaultValue, Lifecycle lifecycleOfDefault)
- lenientOptionalFieldOf
 
 default MapCodec<Optional<A>> lenientOptionalFieldOf(String name)
- lenientOptionalFieldOf
 
 default MapCodec<A> lenientOptionalFieldOf(String name, A defaultValue)
- lenientOptionalFieldOf
 
 default MapCodec<A> lenientOptionalFieldOf(String name, A defaultValue, Lifecycle lifecycleOfDefault)
- lenientOptionalFieldOf
 
 default MapCodec<A> lenientOptionalFieldOf(String name, Lifecycle fieldLifecycle, A defaultValue, Lifecycle lifecycleOfDefault)
- optionalFieldOf
 
 private MapCodec<A> optionalFieldOf(String name, A defaultValue, boolean lenient)
- optionalFieldOf
 
 private MapCodec<A> optionalFieldOf(String name, Lifecycle fieldLifecycle, A defaultValue, Lifecycle lifecycleOfDefault, boolean lenient)
- mapResult
 
 default Codec<A> mapResult(Codec.ResultFunction<A> function)
- orElse
 
 default Codec<A> orElse(Consumer<String> onError, A value)
- orElse
 
 default Codec<A> orElse(UnaryOperator<String> onError, A value)
- orElseGet
 
 default Codec<A> orElseGet(Consumer<String> onError, Supplier<? extends A> value)
- orElseGet
 
 default Codec<A> orElseGet(UnaryOperator<String> onError, Supplier<? extends A> value)
- orElse
 
 default Codec<A> orElse(A value)
- orElseGet
 
 default Codec<A> orElseGet(Supplier<? extends A> value)
- promotePartial
 
 default Codec<A> promotePartial(Consumer<String> onError)
 
 Specified by:
 
 promotePartial in interface Decoder<A>
- dispatch
 
 default <E> Codec<E> dispatch(Function<? super E, ? extends A> type, Function<? super A, ? extends MapCodec<? extends E>> codec)
- dispatch
 
 default <E> Codec<E> dispatch(String typeKey, Function<? super E, ? extends A> type, Function<? super A, ? extends MapCodec<? extends E>> codec)
- dispatchStable
 
 default <E> Codec<E> dispatchStable(Function<? super E, ? extends A> type, Function<? super A, ? extends MapCodec<? extends E>> codec)
- partialDispatch
 
 default <E> Codec<E> partialDispatch(String typeKey, Function<? super E, ? extends DataResult<? extends A>> type, Function<? super A, ? extends DataResult<? extends MapCodec<? extends E>>> codec)
- dispatchMap
 
 default <E> MapCodec<E> dispatchMap(Function<? super E, ? extends A> type, Function<? super A, ? extends MapCodec<? extends E>> codec)
- dispatchMap
 
 default <E> MapCodec<E> dispatchMap(String typeKey, Function<? super E, ? extends A> type, Function<? super A, ? extends MapCodec<? extends E>> codec)
- validate
 
 default Codec<A> validate(Function<A, DataResult<A>> checker)
- checkRange
 
 static <N extends Number & Comparable<N>> Function<N, DataResult<N>> checkRange(N minInclusive, N maxInclusive)
- intRange
 
 static Codec<Integer> intRange(int minInclusive, int maxInclusive)
- floatRange
 
 static Codec<Float> floatRange(float minInclusive, float maxInclusive)
- doubleRange
 
 static Codec<Double> doubleRange(double minInclusive, double maxInclusive)
- string
 
 static Codec<String> string(int minSize, int maxSize)
- sizeLimitedString
 
 static Codec<String> sizeLimitedString(int maxSize)

Interface Codec<A>

Nested Class Summary

Nested classes/interfaces inherited from interface Decoder

Field Summary

Method Summary

Methods inherited from interface Decoder

Methods inherited from interface Encoder

Field Details

BOOL

BYTE

SHORT

INT

LONG

FLOAT

DOUBLE

STRING

BYTE_BUFFER

INT_STREAM

LONG_STREAM

PASSTHROUGH

EMPTY

Method Details

withLifecycle

stable

deprecated

of

of

of

of

pair

either

xor

withAlternative

withAlternative

withAlternative

withAlternative

mapPair

mapEither

list

list

compoundList

simpleMap

unboundedMap

dispatchedMap

stringResolver

optionalField

recursive

lazyInitialized

listOf

listOf

sizeLimitedListOf

xmap

comapFlatMap

flatComapMap

flatXmap

fieldOf

optionalFieldOf

optionalFieldOf

optionalFieldOf

optionalFieldOf

lenientOptionalFieldOf

lenientOptionalFieldOf

lenientOptionalFieldOf

lenientOptionalFieldOf

optionalFieldOf

optionalFieldOf

mapResult

orElse

orElse

orElseGet

orElseGet

orElse

orElseGet

promotePartial

dispatch

dispatch

dispatchStable

partialDispatch

dispatchMap

dispatchMap