Record Class StringValue

java.lang.Object
java.lang.Record
net.nullved.pmweatherapi.util.StringValue
Record Components:
value - The String to store.
All Implemented Interfaces:
Comparable<StringValue>, net.minecraft.util.StringRepresentable

public record StringValue(String value) extends Record implements net.minecraft.util.StringRepresentable, Comparable<StringValue>
An immutable wrapper around Strings that can be used with StringProperty.
Since:
0.14.15.6
  • Nested Class Summary

    Nested classes/interfaces inherited from interface net.minecraft.util.StringRepresentable

    net.minecraft.util.StringRepresentable.EnumCodec<E extends Enum<E> & net.minecraft.util.StringRepresentable>, net.minecraft.util.StringRepresentable.StringRepresentableCodec<S extends net.minecraft.util.StringRepresentable>
  • Field Summary

    Fields inherited from interface net.minecraft.util.StringRepresentable

    PRE_BUILT_MAP_THRESHOLD
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates an instance of a StringValue record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(@NotNull StringValue o)
    Compares this StringValue's value to another StringValue's value
    final boolean
    Indicates whether some other object is "equal to" this one.
    Gets the serialized value
    final int
    Returns a hash code value for this object.
    final String
    Returns a string representation of this record class.
    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

    • StringValue

      public StringValue(String value)
      Creates an instance of a StringValue record class.
      Parameters:
      value - the value for the value record component
  • Method Details

    • getSerializedName

      public String getSerializedName()
      Gets the serialized value
      Specified by:
      getSerializedName in interface net.minecraft.util.StringRepresentable
      Returns:
      The value
      Since:
      0.14.15.6
    • compareTo

      public int compareTo(@NotNull @NotNull StringValue o)
      Compares this StringValue's value to another StringValue's value
      Specified by:
      compareTo in interface Comparable<StringValue>
      Parameters:
      o - The other StringValue
      Returns:
      0 if the strings are equal, 1 if this string is greater, -1 if less than the other
    • 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 String value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component