Package com.marcpg.libpg.web.discord

Record Class Embed.Field

java.lang.Object
java.lang.Record
com.marcpg.libpg.web.discord.Embed.Field
Record Components:
name - The name/title of the field.
value - The plaintext that appears below the name and holds the main information.
inline - If the field should be inline with other fields.
Enclosing class:
Embed
public static record Embed.Field(String name, String value, boolean inline) extends Record
Represents a field of an embed.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Field(String name, String value, boolean inline)
    Creates an instance of a Field record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    build()
    Formats the field 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.
    boolean
    inline()
    Returns the value of the inline record component.
    boolean
    isEmpty()
    Checks if the field's strings are blank.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    value()
    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

    • Field

      public Field(String name, String value, boolean inline)
      Creates an instance of a Field record class.
      Parameters:
      name - the value for the name record component
      value - the value for the value record component
      inline - the value for the inline record component

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Checks if the field's strings are blank.
      Returns:
      true if the field is blank, false otherwise.

    • build

      @NotNull public @NotNull String build()
      Formats the field 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. 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.

    • name

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

    • value

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

    • inline

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