Package cn.nukkit.utils

Record Class OK<E>

java.lang.Object
java.lang.Record
cn.nukkit.utils.OK<E>
Type Parameters:
E - the error parameter
@PowerNukkitXOnly @Since("1.19.60-r1") public record OK<E>(boolean ok, @Nullable E error) extends Record
可携带异常信息的的结果

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final OK<Void>
    TRUE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    OK(boolean ok)
     
    OK(boolean ok, E error)
    Creates an instance of a OK record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    assertOK()
    断言该结果是否为真，如果不为真则会抛出AssertionError
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    E
    error()
    Returns the value of the error record component.
    Throwable
    getError()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    ok()
    Returns the value of the ok 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

  • Field Details

    • TRUE

      public static final OK<Void> TRUE

  • Constructor Details

    • OK

      public OK(boolean ok)

    • OK

      public OK(boolean ok, @Nullable E error)
      Creates an instance of a OK record class.
      Parameters:
      ok - the value for the ok record component
      error - the value for the error record component

  • Method Details

    • getError

      public Throwable getError()

    • assertOK

      public void assertOK() throws AssertionError
      断言该结果是否为真，如果不为真则会抛出AssertionError

      Asserts whether the result is true or not, and throws an AssertionError if it is not true

      Throws:
      AssertionError - the assertion error

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

    • ok

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

    • error

      @Nullable public E error()
      Returns the value of the error record component.
      Returns:
      the value of the error record component