Package com.marcpg.libpg.web.discord

Record Class Embed.Author

java.lang.Object
java.lang.Record
com.marcpg.libpg.web.discord.Embed.Author
Record Components:
name - The author's name in plaintext.
iconUrl - The author's little icon or profile picture.
url - The author URL.
Enclosing class:
Embed
public static record Embed.Author(String name, URL iconUrl, URL url) extends Record
Represents the author information of an embed.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Author(String name, URL iconUrl, URL url)
    Creates an instance of a Author record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    build()
    Formats the author into a compact representation in JSON, which is required for sending it to the Discord API.
    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.
    URL
    iconUrl()
    Returns the value of the iconUrl record component.
    boolean
    isEmpty()
    Checks if the author is empty.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.
    URL
    url()
    Returns the value of the url record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Author

      public Author(String name, URL iconUrl, URL url)
      Creates an instance of a Author record class.
      Parameters:
      name - the value for the name record component
      iconUrl - the value for the iconUrl record component
      url - the value for the url record component

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Checks if the author is empty. This doesn't only include if the values are null, but also if they are empty/blank.
      Returns:
      true if the author is empty, false otherwise.

    • build

      @NotNull public @NotNull String build()
      Formats the author into a compact representation in JSON, which is required for sending it to the Discord API.
      Returns:
      The formatted JSON representation.

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

    • name

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

    • iconUrl

      public URL iconUrl()
      Returns the value of the iconUrl record component.
      Returns:
      the value of the iconUrl record component

    • url

      public URL url()
      Returns the value of the url record component.
      Returns:
      the value of the url record component