Package journeymap.api.v2.server.overlay

Record Class OverlayPolygon

java.lang.Object
java.lang.Record
journeymap.api.v2.server.overlay.OverlayPolygon
Record Components:
outer - the outer ring (required)
holes - interior rings rendered as holes; null or empty for none
public record OverlayPolygon(OverlayPoints outer, @Nullable List<OverlayPoints> holes) extends Record
One polygon: an outer ring and optional holes punched out of it.

  • Constructor Details

    • OverlayPolygon

      public OverlayPolygon(OverlayPoints outer, @Nullable @Nullable List<OverlayPoints> holes)
      Creates an instance of a OverlayPolygon record class.
      Parameters:
      outer - the value for the outer record component
      holes - the value for the holes 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.

    • outer

      public OverlayPoints outer()
      Returns the value of the outer record component.
      Returns:
      the value of the outer record component

    • holes

      @Nullable public @Nullable List<OverlayPoints> holes()
      Returns the value of the holes record component.
      Returns:
      the value of the holes record component