Record Class BlockProperty

java.lang.Object
java.lang.Record
fr.fidorial.world.block.BlockProperty
Record Components:
name - the property name, for instance facing
values - the accepted values, never empty
public record BlockProperty(String name, List<String> values) extends Record
A property of a block type and the values it accepts.
Since:
0.1.0

  • Constructor Details

    • BlockProperty

      public BlockProperty(String name, List<String> values)
      Creates an instance of a BlockProperty record class.
      Parameters:
      name - the value for the name record component
      values - the value for the values record component

  • Method Details

    • indexOf

      public int indexOf(String value)
      Returns the index of a value, or -1 if it is not accepted.
      Parameters:
      value - the value
      Returns:
      the index of a value, or -1 if it is not accepted
      Since:
      0.1.0

    • isValid

      public boolean isValid(String value)
      Returns true if the value is accepted.
      Parameters:
      value - the value
      Returns:
      true if the value is accepted
      Since:
      0.1.0

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

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • values

      public List<String> values()
      Returns the value of the values record component.
      Returns:
      the value of the values record component