Record Class Sidebar.NumberFormat

java.lang.Object
java.lang.Record
net.minestom.server.scoreboard.Sidebar.NumberFormat
All Implemented Interfaces:
ComponentHolder<Sidebar.NumberFormat>
Enclosing class:
Sidebar
public static record Sidebar.NumberFormat(net.minestom.server.scoreboard.Sidebar.NumberFormat.FormatType formatType, @Nullable Component content) extends Record implements ComponentHolder<Sidebar.NumberFormat>

  • Field Details

  • Constructor Details

    • NumberFormat

      public NumberFormat(net.minestom.server.scoreboard.Sidebar.NumberFormat.FormatType formatType, @Nullable @Nullable Component content)
      Creates an instance of a NumberFormat record class.
      Parameters:
      formatType - the value for the formatType record component
      content - the value for the content record component

  • Method Details

    • blank

      public static Sidebar.NumberFormat blank()
      A number format which has no sidebar score displayed
      Returns:
      a blank number format

    • styled

      public static Sidebar.NumberFormat styled(Component style)
      A number format which lets the sidebar scores be styled
      Parameters:
      style - a styled component

    • fixed

      public static Sidebar.NumberFormat fixed(Component content)
      A number format which lets the sidebar scores be styled with explicit text
      Parameters:
      content - the fixed component

    • components

      public Collection<Component> components()
      Description copied from interface: ComponentHolder
      Gets the components held by this object.
      Specified by:
      components in interface ComponentHolder<Sidebar.NumberFormat>
      Returns:
      the components

    • copyWithOperator

      public Sidebar.NumberFormat copyWithOperator(UnaryOperator<Component> operator)
      Description copied from interface: ComponentHolder
      Returns a copy of this object. For each component this object holds, the operator is applied to the copy before returning.
      Specified by:
      copyWithOperator in interface ComponentHolder<Sidebar.NumberFormat>
      Parameters:
      operator - the operator
      Returns:
      the copy

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

    • formatType

      public net.minestom.server.scoreboard.Sidebar.NumberFormat.FormatType formatType()
      Returns the value of the formatType record component.
      Returns:
      the value of the formatType record component

    • content

      @Nullable public @Nullable Component content()
      Returns the value of the content record component.
      Returns:
      the value of the content record component