Record Class SunriseResult.AllNight

java.lang.Object
java.lang.Record
net.e175.klaus.solarpositioning.SunriseResult.AllNight
Record Components:
transit - Time of transit (culmination), i.e. when the sun is closest to the zenith.
All Implemented Interfaces:
SunriseResult
Enclosing interface:
SunriseResult

public static record SunriseResult.AllNight(ZonedDateTime transit) extends Record implements SunriseResult
A day on which the sun is below the horizon all the time (polar night).
  • Constructor Details

    • AllNight

      public AllNight(ZonedDateTime transit)
      Creates an instance of a AllNight record class.
      Parameters:
      transit - the value for the transit 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.
    • transit

      public ZonedDateTime transit()
      Returns the value of the transit record component.
      Specified by:
      transit in interface SunriseResult
      Returns:
      the value of the transit record component