Package net.minestom.server.utils

Record Class Either<L,R>

java.lang.Object
java.lang.Record
net.minestom.server.utils.Either<L,R>
public record Either<L,R>(boolean isLeft, L left, R right) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    Either(boolean isLeft, L left, R right)
    Creates an instance of a Either 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.
    boolean
    isLeft()
    Returns the value of the isLeft record component.
    L
    left()
    Returns the value of the left record component.
    static <T, U> Either<T,U>
    left(T left)
     
    <T> T
    map(Function<L,T> leftMapper, Function<R,T> rightMapper)
     
    R
    right()
    Returns the value of the right record component.
    static <T, U> Either<U,T>
    right(T right)
     
    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

    • Either

      public Either(boolean isLeft, L left, R right)
      Creates an instance of a Either record class.
      Parameters:
      isLeft - the value for the isLeft record component
      left - the value for the left record component
      right - the value for the right record component

  • Method Details

    • left

      public static <T, U> Either<T,U> left(T left)

    • right

      public static <T, U> Either<U,T> right(T right)

    • map

      public <T> T map(Function<L,T> leftMapper, Function<R,T> rightMapper)

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

    • isLeft

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

    • left

      public L left()
      Returns the value of the left record component.
      Returns:
      the value of the left record component

    • right

      public R right()
      Returns the value of the right record component.
      Returns:
      the value of the right record component