Package com.thewinterframework.configurate.feedback.media.impl

Record Class BossBarMedia

java.lang.Object
java.lang.Record
com.thewinterframework.configurate.feedback.media.impl.BossBarMedia
All Implemented Interfaces:
FeedbackMedia
public record BossBarMedia(String message, float progress, net.kyori.adventure.bossbar.BossBar.Color color, net.kyori.adventure.bossbar.BossBar.Overlay overlay) extends Record implements FeedbackMedia

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    BossBarMedia.BossBarMediaSerializer
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    BossBarMedia(String message, float progress, net.kyori.adventure.bossbar.BossBar.Color color, net.kyori.adventure.bossbar.BossBar.Overlay overlay)
    Creates an instance of a BossBarMedia record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    net.kyori.adventure.bossbar.BossBar.Color
    color()
    Returns the value of the color record 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.
    String
    message()
    Returns the value of the message record component.
    net.kyori.adventure.bossbar.BossBar.Overlay
    overlay()
    Returns the value of the overlay record component.
    float
    progress()
    Returns the value of the progress record component.
    void
    sendMedia(net.kyori.adventure.audience.Audience audience, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... resolvers)
    Sends the media to the specified Audience.
    final String
    toString()
    Returns a string representation of this record class.
    MediaType
    type()
    Gets the type of media.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • BossBarMedia

      public BossBarMedia(String message, float progress, net.kyori.adventure.bossbar.BossBar.Color color, net.kyori.adventure.bossbar.BossBar.Overlay overlay)
      Creates an instance of a BossBarMedia record class.
      Parameters:
      message - the value for the message record component
      progress - the value for the progress record component
      color - the value for the color record component
      overlay - the value for the overlay record component

  • Method Details

    • sendMedia

      public void sendMedia(net.kyori.adventure.audience.Audience audience, net.kyori.adventure.text.minimessage.tag.resolver.TagResolver... resolvers)
      Description copied from interface: FeedbackMedia
      Sends the media to the specified Audience.
      Specified by:
      sendMedia in interface FeedbackMedia
      Parameters:
      audience - the audience to send the media to
      resolvers - the tag resolvers to use

    • type

      public MediaType type()
      Description copied from interface: FeedbackMedia
      Gets the type of media.
      Specified by:
      type in interface FeedbackMedia
      Returns:
      the type of media

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

    • message

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

    • progress

      public float progress()
      Returns the value of the progress record component.
      Returns:
      the value of the progress record component

    • color

      public net.kyori.adventure.bossbar.BossBar.Color color()
      Returns the value of the color record component.
      Returns:
      the value of the color record component

    • overlay

      public net.kyori.adventure.bossbar.BossBar.Overlay overlay()
      Returns the value of the overlay record component.
      Returns:
      the value of the overlay record component