Record Class WorldsResponse

java.lang.Object
java.lang.Record
de.chojo.universalis.rest.response.WorldsResponse
Record Components:
worlds - worlds
All Implemented Interfaces:
Iterable<World>
public record WorldsResponse(List<World> worlds) extends Record implements Iterable<World>
Response of a WorldsRequest

  • Constructor Details

    • WorldsResponse

      public WorldsResponse(List<World> worlds)
      Creates an instance of a WorldsResponse record class.
      Parameters:
      worlds - the value for the worlds record component

  • Method Details

    • iterator

      @NotNull public @NotNull Iterator<World> iterator()
      Specified by:
      iterator in interface Iterable<World>

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

    • worlds

      public List<World> worlds()
      Returns the value of the worlds record component.
      Returns:
      the value of the worlds record component