Record Class WidthComponent

java.lang.Object
java.lang.Record
kr.toxicity.hud.api.component.WidthComponent
Record Components:
component - component
width - width
public record WidthComponent(net.kyori.adventure.text.TextComponent.Builder component, int width) extends Record
Component with width

  • Constructor Summary

    Constructors
    Constructor
    Description
    WidthComponent(net.kyori.adventure.text.TextComponent.Builder component, int width)
    Creates an instance of a WidthComponent record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    net.kyori.adventure.text.TextComponent.Builder
    component()
    Returns the value of the component record component.
    @NotNull WidthComponent
    copy()
    Copy component
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    @NotNull WidthComponent
    plus(@NotNull WidthComponent other)
    Adds component
    final String
    toString()
    Returns a string representation of this record class.
    int
    width()
    Returns the value of the width record component.

    Methods inherited from class Object

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

  • Constructor Details

    • WidthComponent

      public WidthComponent(@NotNull net.kyori.adventure.text.TextComponent.Builder component, int width)
      Creates an instance of a WidthComponent record class.
      Parameters:
      component - the value for the component record component
      width - the value for the width record component

  • Method Details

    • plus

      @NotNull public @NotNull WidthComponent plus(@NotNull @NotNull WidthComponent other)
      Adds component
      Parameters:
      other - other
      Returns:
      Merged component

    • copy

      @NotNull public @NotNull WidthComponent copy()
      Copy component
      Returns:
      copied component

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • component

      @NotNull public net.kyori.adventure.text.TextComponent.Builder component()
      Returns the value of the component record component.
      Returns:
      the value of the component record component

    • width

      public int width()
      Returns the value of the width record component.
      Returns:
      the value of the width record component