Package org.teleight.teleightbots.api.objects

Record Class StoryArea

java.lang.Object
java.lang.Record
org.teleight.teleightbots.api.objects.StoryArea
All Implemented Interfaces:
Serializable, ApiResult
public record StoryArea(@NotNull StoryAreaPosition position, @NotNull StoryAreaType type) extends Record implements ApiResult
See Also:

  • Constructor Details

    • StoryArea

      public StoryArea(@NotNull @NotNull StoryAreaPosition position, @NotNull @NotNull StoryAreaType type)
      Creates an instance of a StoryArea record class.
      Parameters:
      position - the value for the position record component
      type - the value for the type 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.

    • position

      @NotNull public @NotNull StoryAreaPosition position()
      Returns the value of the position record component.
      Returns:
      the value of the position record component

    • type

      @NotNull public @NotNull StoryAreaType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component