Package com.petrolpark.core.scratch.argument

Record Class LiteralArgument<TYPE>

java.lang.Object
java.lang.Record
com.petrolpark.core.scratch.argument.LiteralArgument<TYPE>
All Implemented Interfaces:
IScratchArgument<IScratchEnvironment,TYPE>
public record LiteralArgument<TYPE>(TYPE value, LiteralArgument.LiteralParameter<TYPE> parameter) extends Record implements IScratchArgument<IScratchEnvironment,TYPE>

  • Constructor Details

    • LiteralArgument

      public LiteralArgument(TYPE value, LiteralArgument.LiteralParameter<TYPE> parameter)
      Creates an instance of a LiteralArgument record class.
      Parameters:
      value - the value for the value record component
      parameter - the value for the parameter record component

  • Method Details

    • get

      public TYPE get(IScratchEnvironment context)
      Specified by:
      get in interface IScratchArgument<IScratchEnvironment,TYPE>

    • intLiteral

      public static final LiteralArgument.LiteralParameter<Integer> intLiteral(String key)

    • 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 TYPE value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • parameter

      public LiteralArgument.LiteralParameter<TYPE> parameter()
      Returns the value of the parameter record component.
      Specified by:
      parameter in interface IScratchArgument<IScratchEnvironment,TYPE>
      Returns:
      the value of the parameter record component