Record Class HudSegmentedControl.Segment<T>

java.lang.Object
java.lang.Record
mekhq.gui.baseComponents.hud.HudSegmentedControl.Segment<T>
Record Components:
value - the value the segment stands for
title - the segment's title
sub - the segment's sub-line, or null for none
enabled - true if the player may choose the segment
Enclosing class:
HudSegmentedControl<T>

public static record HudSegmentedControl.Segment<T>(T value, String title, String sub, boolean enabled) extends Record
One segment of the control.
Since:
0.51.01
  • Constructor Summary

    Constructors
    Constructor
    Description
    Segment(T value, String title, String sub, boolean enabled)
    Creates an instance of a Segment record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Returns the value of the enabled record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    sub()
    Returns the value of the sub record component.
    Returns the value of the title record component.
    final String
    Returns a string representation of this record class.
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • Segment

      public Segment(T value, String title, @Nullable String sub, boolean enabled)
      Creates an instance of a Segment record class.
      Parameters:
      value - the value for the value record component
      title - the value for the title record component
      sub - the value for the sub record component
      enabled - the value for the enabled record component
  • Method Details

    • 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 '=='.
      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.
    • value

      public T value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component
    • title

      public String title()
      Returns the value of the title record component.
      Returns:
      the value of the title record component
    • sub

      @Nullable public String sub()
      Returns the value of the sub record component.
      Returns:
      the value of the sub record component
    • enabled

      public boolean enabled()
      Returns the value of the enabled record component.
      Returns:
      the value of the enabled record component