Package com.amazon.A3L.location

Class A3LCurrentLocationRequest

  • All Implemented Interfaces:
    android.os.Parcelable
    public class A3LCurrentLocationRequest
extends java.lang.Object
implements android.os.Parcelable
    This class provides replication of CurrentLocationRequest .

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  A3LCurrentLocationRequest.Builder
      A builder for A3LCurrentLocationRequest.

      • Nested classes/interfaces inherited from interface android.os.Parcelable

        android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.ContentsFlags, android.os.Parcelable.Creator<T>, android.os.Parcelable.Stability, android.os.Parcelable.WriteFlags

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static android.os.Parcelable.Creator<A3LCurrentLocationRequest> CREATOR
      Creator used for fetching data from the parcel received by an activity

      • Fields inherited from interface android.os.Parcelable

        CONTENTS_FILE_DESCRIPTOR, PARCELABLE_ELIDE_DUPLICATES, PARCELABLE_STABILITY_LOCAL, PARCELABLE_STABILITY_VINTF, PARCELABLE_WRITE_RETURN_VALUE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int describeContents()
      Needed for Parcelling
      boolean equals​(java.lang.Object object)
      Overridden method to verify if the current A3LCurrentLocationRequest Object and the one requested have same data.
      long getDurationMillis()
      The duration in milliseconds of the location request used to derive the current location if no historical location satisfies the current location request.
      int getGranularity()
      The A3LGranularity of locations returned for this request.
      long getMaxUpdateAgeMillis()
      The maximum age of any location returned for this request.
      int getPriority()
      The A3LPriority of the location request used to derive the current location if no historical location satisfies the current location request.
      int hashCode()  
      java.lang.String toString()  
      void writeToParcel​(android.os.Parcel dest, int flags)
      Flatten this object in to a Parcel.

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface android.os.Parcelable

        getStability

    • Field Detail

      • CREATOR

        @NonNull
public static final android.os.Parcelable.Creator<A3LCurrentLocationRequest> CREATOR
        Creator used for fetching data from the parcel received by an activity

    • Method Detail

      • getMaxUpdateAgeMillis

        public long getMaxUpdateAgeMillis()
        The maximum age of any location returned for this request. A value of 0 indicates that only freshly derived locations will be returned, and no historical locations will ever be returned. A value Long.MAX_VALUE represents an effectively unbounded maximum age.
        Returns:
        long: Maximum age of any location returned.

      • getGranularity

        public int getGranularity()
        The A3LGranularity of locations returned for this request. This controls whether fine or coarse locations may be returned.
        Returns:
        int: Granularity of the location.

      • getPriority

        public int getPriority()
        The A3LPriority of the location request used to derive the current location if no historical location satisfies the current location request.
        Returns:
        int: Priority of the location request.

      • getDurationMillis

        public long getDurationMillis()
        The duration in milliseconds of the location request used to derive the current location if no historical location satisfies the current location request. If this duration expires with no location, the current location request will return a null location. The current location request may fail and return a null location after a shorter duration (ie, the given duration may be capped internally), but never a longer duration.
        Returns:
        long: The duration in milliseconds of the location request.

      • toString

        @NonNull
public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • describeContents

        public int describeContents()
        Needed for Parcelling
        Specified by:
        describeContents in interface android.os.Parcelable
        Returns:
        int: 0

      • writeToParcel

        public void writeToParcel​(@NonNull
                          android.os.Parcel dest,
                          int flags)
        Flatten this object in to a Parcel.
        Specified by:
        writeToParcel in interface android.os.Parcelable
        Parameters:
        dest - The Parcel in which the object should be written.
        flags - Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.

      • equals

        public boolean equals​(java.lang.Object object)
        Overridden method to verify if the current A3LCurrentLocationRequest Object and the one requested have same data.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        object - : A3LCurrentLocationRequest
        Returns:
        boolean: true if both objects have same information

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object