Record Class SettingUserIdResult

java.lang.Object
java.lang.Record
com.iohao.net.framework.protocol.SettingUserIdResult
Record Components:
errorCode - error code; 0 indicates success
errorMessage - human-readable error description; null on success
public record SettingUserIdResult(int errorCode, String errorMessage) extends Record
Result of a user id binding (setting) operation on the external server.

An error code of 0 indicates the user id was successfully bound to the session. Pre-defined constants SUCCESS and ERROR cover the most common outcomes.

Since:
21.19
Author:
渔民小镇
date:
2024-10-18

  • Field Details

  • Constructor Details

    • SettingUserIdResult

      public SettingUserIdResult(int errorCode, String errorMessage)
      Creates an instance of a SettingUserIdResult record class.
      Parameters:
      errorCode - the value for the errorCode record component
      errorMessage - the value for the errorMessage record component

  • Method Details

    • success

      public boolean success()
      Check whether the operation completed successfully.
      Returns:
      true if the error code is 0

    • ofError

      public static SettingUserIdResult ofError(String errorMessage)
      Create an error result with a validation error code and the given message.
      Parameters:
      errorMessage - the error description
      Returns:
      a new error result

    • ofError

      public static SettingUserIdResult ofError(ErrorInformation errorInformation)
      Create an error result from the given ErrorInformation.
      Parameters:
      errorInformation - the error information source
      Returns:
      a new error result

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

    • errorCode

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

    • errorMessage

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