Package dan200.computercraft.api.lua

Record Class Coerced<T>

java.lang.Object
java.lang.Record
dan200.computercraft.api.lua.Coerced<T>
Type Parameters:
T - The type of the underlying value.
Record Components:
value - The argument value.
public record Coerced<T>(T value) extends Record
A wrapper type for "coerced" values.

This is designed to be used with LuaFunction annotated functions, to mark an argument as being coerced to the given type, rather than requiring an exact type.

Example:


 @LuaFunction
 public final void doSomething(Coerced<String> myString) {
   var value = myString.value();
 }
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Coerced(T value)
    Creates an instance of a Coerced 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.
    final String
    toString()
    Returns a string representation of this record class.
    T
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Coerced

      public Coerced(T value)
      Creates an instance of a Coerced record class.
      Parameters:
      value - the value for the value 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • value

      public T value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component