Package dev.adlin.vts4j.network

Record Class CloseReason

java.lang.Object
java.lang.Record
dev.adlin.vts4j.network.CloseReason
public record CloseReason(int code, @NotNull String reason, boolean remote) extends Record
An object for convenient work with reasons for WebSocket closure

  • Constructor Summary

    Constructors
    Constructor
    Description
    CloseReason(int code, @NotNull String reason, boolean remote)
    Creates an instance of a CloseReason record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    code()
    Returns the value of the code 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.
    @NotNull String
    reason()
    Returns the value of the reason record component.
    boolean
    remote()
    Returns the value of the remote record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CloseReason

      public CloseReason(int code, @NotNull @NotNull String reason, boolean remote)
      Creates an instance of a CloseReason record class.
      Parameters:
      code - the value for the code record component
      reason - the value for the reason record component
      remote - the value for the remote 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 '=='.
      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.

    • code

      public int code()
      Returns the value of the code record component.
      Returns:
      the value of the code record component

    • reason

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

    • remote

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