Record Class LaunchedClient.LaunchedBy

java.lang.Object
java.lang.Record
com.botwithus.bot.api.script.LaunchedClient.LaunchedBy
Record Components:
pid - the host's process id
hostKind - "java" or "native"
label - the host's display label, if it gave one
Enclosing class:
LaunchedClient
public static record LaunchedClient.LaunchedBy(long pid, String hostKind, Optional<String> label) extends Record
The host connection that launched a client.

  • Constructor Summary

    Constructors
    Constructor
    Description
    LaunchedBy(long pid, String hostKind, Optional<String> label)
    Creates an instance of a LaunchedBy record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    hostKind()
    Returns the value of the hostKind record component.
    Optional<String>
    label()
    Returns the value of the label record component.
    long
    pid()
    Returns the value of the pid record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • LaunchedBy

      public LaunchedBy(long pid, String hostKind, Optional<String> label)
      Creates an instance of a LaunchedBy record class.
      Parameters:
      pid - the value for the pid record component
      hostKind - the value for the hostKind record component
      label - the value for the label 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • pid

      public long pid()
      Returns the value of the pid record component.
      Returns:
      the value of the pid record component

    • hostKind

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

    • label

      public Optional<String> label()
      Returns the value of the label record component.
      Returns:
      the value of the label record component