Package io.github.toberocat.guiengine.function.call

Record Class AddComponentsFunction

java.lang.Object
java.lang.Record
io.github.toberocat.guiengine.function.call.AddComponentsFunction
All Implemented Interfaces:
GuiFunction
public record AddComponentsFunction(@NotNull com.fasterxml.jackson.databind.JsonNode root) extends Record implements GuiFunction
Custom GUI function to add components to the GUI.

Created: 29.04.2023 Author: Tobias Madlberger (Tobias)

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    protected static class 
    AddComponentsFunction.Deserializer
    Custom deserializer to convert JSON data into an `AddComponentsFunction` instance.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ID
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AddComponentsFunction(@NotNull com.fasterxml.jackson.databind.JsonNode root)
    Creates an instance of a AddComponentsFunction record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    call(@NotNull GuiEngineApi api, @NotNull GuiContext context)
    Calls the `addComponents` method using the provided API and context to add components to the GUI.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @NotNull String
    getType()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    @NotNull com.fasterxml.jackson.databind.JsonNode
    root()
    Returns the value of the root record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • AddComponentsFunction

      public AddComponentsFunction(@NotNull @NotNull com.fasterxml.jackson.databind.JsonNode root)
      Creates an instance of a AddComponentsFunction record class.
      Parameters:
      root - the value for the root record component

  • Method Details

    • getType

      @NotNull public @NotNull String getType()
      Specified by:
      getType in interface GuiFunction

    • call

      public void call(@NotNull @NotNull GuiEngineApi api, @NotNull @NotNull GuiContext context)
      Calls the `addComponents` method using the provided API and context to add components to the GUI.
      Specified by:
      call in interface GuiFunction
      Parameters:
      api - The `GuiEngineApi` instance used to interact with the GUI engine.
      context - The `GuiContext` instance representing the GUI context to which components will be added.

    • 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.

    • root

      @NotNull public @NotNull com.fasterxml.jackson.databind.JsonNode root()
      Returns the value of the root record component.
      Returns:
      the value of the root record component