Class BuilderCodec.BuilderBase<T, S extends BuilderCodec.BuilderBase<T,S>>

java.lang.Object

com.hypixel.hytale.codec.builder.BuilderCodec.BuilderBase<T,S>

Direct Known Subclasses:

AssetBuilderCodec.Builder, BuilderCodec.Builder

Enclosing class:

BuilderCodec<T>

public abstract static class BuilderCodec.BuilderBase<T, S extends BuilderCodec.BuilderBase<T,S>>
extends Object

Since:

18/8/17.

Version:

1.0

Method Summary

Modifier and Type	Method	Description
<FieldType> S	addField(BuilderField<T, FieldType> entry)
<FieldType> S	addField(KeyedCodec<FieldType> codec, BiConsumer<T, FieldType> setter, Function<T, FieldType> getter)	Deprecated. Please use append(KeyedCodec, BiConsumer, Function) or appendInherited(KeyedCodec, BiConsumer, Function, BiConsumer) instead as they allow you to provide documentation and validation.
S	afterDecode(BiConsumer<T, ExtraInfo> afterDecode)
S	afterDecode(Consumer<T> afterDecode)
<FieldType> BuilderField.FieldBuilder<T, FieldType, S>	append(KeyedCodec<FieldType> codec, TriConsumer<T, FieldType, ExtraInfo> setter, BiFunction<T, ExtraInfo, FieldType> getter)
<FieldType> BuilderField.FieldBuilder<T, FieldType, S>	append(KeyedCodec<FieldType> codec, BiConsumer<T, FieldType> setter, Function<T, FieldType> getter)
<FieldType> BuilderField.FieldBuilder<T, FieldType, S>	appendInherited(KeyedCodec<FieldType> codec, TriConsumer<T, FieldType, ExtraInfo> setter, BiFunction<T, ExtraInfo, FieldType> getter, TriConsumer<T, T, ExtraInfo> inherit)
<FieldType> BuilderField.FieldBuilder<T, FieldType, S>	appendInherited(KeyedCodec<FieldType> codec, BiConsumer<T, FieldType> setter, Function<T, FieldType> getter, BiConsumer<T,T> inherit)
BuilderCodec<T>	build()
S	codecVersion(int codecVersion)
S	codecVersion(int minCodecVersion, int codecVersion)
S	documentation(String doc)
S	legacyVersioned()	Deprecated. Used to allow builder codecs to fetch the version information from ExtraInfo.getLegacyVersion() for backwards compat
S	metadata(Metadata metadata)
S	validator(BiConsumer<T, ValidationResults> validator)	Deprecated.
S	versioned()	Marks the codec as versioned.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

documentation

@Nonnull
public S documentation(String doc)

versioned

@Nonnull
public S versioned()

Marks the codec as versioned.

When a codec is versioned it stores version information along with the rest of the serialized data. This version will affect all fields within the codec and any version specific handling within any of the codecs of those fields (e.g. a nested BuilderCodec) unless that codec is versioned itself.

A codec doesn't have to be versioned in order to use methods such as BuilderField.FieldBuilder.setVersionRange(int, int). When the codec isn't versioned itself it will inherit the version parent codec (or ExtraInfo as a fallback).

legacyVersioned

@Nonnull
@Deprecated
public S legacyVersioned()

Deprecated.

Used to allow builder codecs to fetch the version information from ExtraInfo.getLegacyVersion() for backwards compat

addField

@Nonnull
@Deprecated
public <FieldType> S addField(@Nonnull
 KeyedCodec<FieldType> codec,
 @Nonnull
 BiConsumer<T, FieldType> setter,
 @Nonnull
 Function<T, FieldType> getter)

Deprecated.

Please use append(KeyedCodec, BiConsumer, Function) or appendInherited(KeyedCodec, BiConsumer, Function, BiConsumer) instead as they allow you to provide documentation and validation.

append

@Nonnull
public <FieldType>
BuilderField.FieldBuilder<T, FieldType, S> append(KeyedCodec<FieldType> codec,
 @Nonnull
 BiConsumer<T, FieldType> setter,
 @Nonnull
 Function<T, FieldType> getter)

append

@Nonnull
public <FieldType>
BuilderField.FieldBuilder<T, FieldType, S> append(KeyedCodec<FieldType> codec,
 TriConsumer<T, FieldType, ExtraInfo> setter,
 BiFunction<T, ExtraInfo, FieldType> getter)

appendInherited

@Nonnull
public <FieldType>
BuilderField.FieldBuilder<T, FieldType, S> appendInherited(KeyedCodec<FieldType> codec,
 @Nonnull
 BiConsumer<T, FieldType> setter,
 @Nonnull
 Function<T, FieldType> getter,
 @Nonnull
 BiConsumer<T,T> inherit)

appendInherited

@Nonnull
public <FieldType>
BuilderField.FieldBuilder<T, FieldType, S> appendInherited(KeyedCodec<FieldType> codec,
 TriConsumer<T, FieldType, ExtraInfo> setter,
 BiFunction<T, ExtraInfo, FieldType> getter,
 TriConsumer<T, T, ExtraInfo> inherit)

addField

@Nonnull
public <FieldType> S addField(@Nonnull
 BuilderField<T, FieldType> entry)

afterDecode

@Nonnull
public S afterDecode(@Nonnull
 Consumer<T> afterDecode)

afterDecode

@Nonnull
public S afterDecode(BiConsumer<T, ExtraInfo> afterDecode)

validator

@Nonnull
@Deprecated
public S validator(BiConsumer<T, ValidationResults> validator)

Deprecated.

metadata

@Nonnull
public S metadata(Metadata metadata)

codecVersion

@Nonnull
public S codecVersion(int minCodecVersion,
 int codecVersion)

codecVersion

@Nonnull
public S codecVersion(int codecVersion)

build

@Nonnull
public BuilderCodec<T> build()