Record Class Message.Sidebar

java.lang.Object
java.lang.Record
net.flectone.pulse.config.Message.Sidebar
All Implemented Interfaces:
EnableSetting
Enclosing class:
Message
public static record Message.Sidebar(Boolean enable, Boolean random, Integer width, Integer height, Integer top, Integer right, Integer labelTop, Integer labelLeft, String background, Ticker ticker) extends Record implements EnableSetting
Since:
1.7.1

  • Constructor Details

    • Sidebar

      public Sidebar(Boolean enable, Boolean random, Integer width, Integer height, Integer top, Integer right, Integer labelTop, Integer labelLeft, String background, Ticker ticker)
      Creates an instance of a Sidebar record class.
      Parameters:
      enable - the value for the enable record component
      random - the value for the random record component
      width - the value for the width record component
      height - the value for the height record component
      top - the value for the top record component
      right - the value for the right record component
      labelTop - the value for the labelTop record component
      labelLeft - the value for the labelLeft record component
      background - the value for the background record component
      ticker - the value for the ticker record component

  • Method Details

    • builder

      public static Message.Sidebar.SidebarBuilder builder()

    • toBuilder

      public Message.Sidebar.SidebarBuilder toBuilder()

    • withEnable

      public Message.Sidebar withEnable(Boolean enable)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withRandom

      public Message.Sidebar withRandom(Boolean random)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withWidth

      public Message.Sidebar withWidth(Integer width)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withHeight

      public Message.Sidebar withHeight(Integer height)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withTop

      public Message.Sidebar withTop(Integer top)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withRight

      public Message.Sidebar withRight(Integer right)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withLabelTop

      public Message.Sidebar withLabelTop(Integer labelTop)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withLabelLeft

      public Message.Sidebar withLabelLeft(Integer labelLeft)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withBackground

      public Message.Sidebar withBackground(String background)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

    • withTicker

      public Message.Sidebar withTicker(Ticker ticker)
      Returns:
      a clone of this object, except with this updated property (returns this if an identical value is passed).

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

    • enable

      public Boolean enable()
      Returns the value of the enable record component.
      Specified by:
      enable in interface EnableSetting
      Returns:
      the value of the enable record component

    • random

      public Boolean random()
      Returns the value of the random record component.
      Returns:
      the value of the random record component

    • width

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

    • height

      public Integer height()
      Returns the value of the height record component.
      Returns:
      the value of the height record component

    • top

      public Integer top()
      Returns the value of the top record component.
      Returns:
      the value of the top record component

    • right

      public Integer right()
      Returns the value of the right record component.
      Returns:
      the value of the right record component

    • labelTop

      public Integer labelTop()
      Returns the value of the labelTop record component.
      Returns:
      the value of the labelTop record component

    • labelLeft

      public Integer labelLeft()
      Returns the value of the labelLeft record component.
      Returns:
      the value of the labelLeft record component

    • background

      public String background()
      Returns the value of the background record component.
      Returns:
      the value of the background record component

    • ticker

      public Ticker ticker()
      Returns the value of the ticker record component.
      Returns:
      the value of the ticker record component