/* * Copyright (c) Forge Development LLC and contributors * SPDX-License-Identifier: LGPL-2.1-only */ package net.minecraftforge.common; import com.mojang.datafixers.util.Either; import com.mojang.serialization.Codec; import com.mojang.serialization.DataResult; import net.minecraft.util.ExtraCodecs; import net.minecraft.util.StringRepresentable; import java.util.function.Function; import java.util.function.Supplier; /** * To be implemented on vanilla enums that should be enhanced with ASM to be * extensible. If this is implemented on a class, the class must define a static * method called "create" which takes a String (enum name), and the rest of the * parameters matching a constructor. *

* For example, an enum with the constructor {@code MyEnum(Object foo)} would * require the method: * *

 * public static MyEnum create(String name, Object foo)
 * {
 *     throw new IllegalStateException("Enum not extended");
 * }
 * 
* * The method contents will be replaced with ASM at runtime. Multiple * {@code create} methods can be defined as long as each * matches a constructor. */ public interface IExtensibleEnum { /** * Called by generated factory code to do any post-constructor setup required by * the enum. Should not be called manually. */ @Deprecated default void init() {} /** * Use this instead of {@link StringRepresentable#fromEnum(Supplier)} for extensible enums because this not cache the enum values on construction */ static & StringRepresentable> Codec createCodecForExtensibleEnum(Supplier valuesSupplier, Function enumValueFromNameFunction) { return Codec.either(Codec.STRING, Codec.INT).comapFlatMap( either -> either.map( str -> { var val = enumValueFromNameFunction.apply(str); return val != null ? DataResult.success(val) : DataResult.error(() -> "Unknown enum value name: " + str); }, num -> { var values = valuesSupplier.get(); return num >= 0 && num < values.length ? DataResult.success(values[num]) : DataResult.error(() -> "Unknown enum id: " + num); } ), value -> Either.left(value.getSerializedName()) ); } }