Record Class ManagementTarget.Group

java.lang.Object
java.lang.Record
com.botwithus.bot.api.script.ManagementTarget.Group
Record Components:
id - the group's id; it never changes, so it is the thing to keep
name - the group's name as it is now; it changes when the group is renamed, and it is what the ClientOrchestrator's group methods take
All Implemented Interfaces:
ManagementTarget
Enclosing interface:
ManagementTarget
public static record ManagementTarget.Group(String id, String name) extends Record implements ManagementTarget
Every client in a group, and every script on each.

  • Constructor Details

    • Group

      public Group(String id, String name)
      Creates an instance of a Group record class.
      Parameters:
      id - the value for the id record component
      name - the value for the name 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. 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.

    • id

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

    • name

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