Package com.vaadin.flow.component.geolocation

Record Class GeolocationPosition

java.lang.Object
java.lang.Record
com.vaadin.flow.component.geolocation.GeolocationPosition
Record Components:
coords - the latitude/longitude and related fields; see GeolocationCoordinates
timestamp - the moment the reading was taken, as milliseconds since the Unix epoch (1970-01-01T00:00:00Z). Use timestampAsInstant() for an Instant
All Implemented Interfaces:
GeolocationOutcome, GeolocationResult, Serializable
public record GeolocationPosition(GeolocationCoordinates coords, long timestamp) extends Record implements GeolocationOutcome
A successful location reading: the coordinates the browser reported and the moment in time they were taken.

This is one of the three possible values of a GeolocationWatcher.valueSignal() signal, and the value passed to the success callback of Geolocation.getPosition.

See Also:

  • Constructor Details

    • GeolocationPosition

      public GeolocationPosition(GeolocationCoordinates coords, long timestamp)
      Creates an instance of a GeolocationPosition record class.
      Parameters:
      coords - the value for the coords record component
      timestamp - the value for the timestamp record component

  • Method Details

    • timestampAsInstant

      public Instant timestampAsInstant()
      Returns the reading's timestamp as an Instant.
      Returns:
      the timestamp as an Instant

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • coords

      public GeolocationCoordinates coords()
      Returns the value of the coords record component.
      Returns:
      the value of the coords record component

    • timestamp

      public long timestamp()
      Returns the value of the timestamp record component.
      Returns:
      the value of the timestamp record component