Record Class PackMeta

java.lang.Object
java.lang.Record
kr.toxicity.model.api.pack.PackMeta
Record Components:
pack - the main pack configuration
overlays - the optional overlays configuration
public record PackMeta(@NotNull PackMeta.Pack pack, @Nullable PackMeta.Overlay overlays) extends Record
Represents the metadata (pack.mcmeta) of a resource pack.

This record handles the serialization and deserialization of the pack metadata, including pack format, description, and supported formats. It also supports overlays for multi-version support.

Since:
1.15.2

  • Field Details

    • PATH

      public static final PackPath PATH
      The standard path for the pack metadata file.
      Since:
      1.15.2

  • Constructor Details

    • PackMeta

      public PackMeta(@NotNull @NotNull PackMeta.Pack pack, @Nullable @Nullable PackMeta.Overlay overlays)
      Creates an instance of a PackMeta record class.
      Parameters:
      pack - the value for the pack record component
      overlays - the value for the overlays record component

  • Method Details

    • builder

      @NotNull public static @NotNull PackMeta.Builder builder()
      Creates a new builder for PackMeta.
      Returns:
      a new builder instance
      Since:
      1.15.2

    • toJson

      @NotNull public @NotNull com.google.gson.JsonElement toJson()
      Converts this metadata to a JSON element.
      Returns:
      the JSON representation
      Since:
      1.15.2

    • toResource

      @NotNull public @NotNull PackResource toResource()
      Converts this metadata to a pack resource.
      Returns:
      the pack resource containing the JSON data
      Since:
      1.15.2

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • pack

      @NotNull public @NotNull PackMeta.Pack pack()
      Returns the value of the pack record component.
      Returns:
      the value of the pack record component

    • overlays

      @Nullable public @Nullable PackMeta.Overlay overlays()
      Returns the value of the overlays record component.
      Returns:
      the value of the overlays record component