diff --git a/MyTracks/src/com/google/android/apps/mytracks/services/AbsoluteLocationListenerPolicy.java b/MyTracks/src/com/google/android/apps/mytracks/services/AbsoluteLocationListenerPolicy.java index 2ae2aa899..f9240baca 100644 --- a/MyTracks/src/com/google/android/apps/mytracks/services/AbsoluteLocationListenerPolicy.java +++ b/MyTracks/src/com/google/android/apps/mytracks/services/AbsoluteLocationListenerPolicy.java @@ -19,41 +19,34 @@ package com.google.android.apps.mytracks.services; /** * This is a simple location listener policy that will always dictate the same * polling interval. - * + * * @author Sandor Dornbush */ public class AbsoluteLocationListenerPolicy implements LocationListenerPolicy { - /** - * The interval to request for gps signal. - */ private final long interval; /** - * @param interval The interval to request for gps signal + * Constructor. + * + * @param interval the interval to request for gps signal */ - public AbsoluteLocationListenerPolicy(final long interval) { + public AbsoluteLocationListenerPolicy(long interval) { this.interval = interval; } - /** - * @return The interval given in the constructor - */ + @Override public long getDesiredPollingInterval() { return interval; } - /** - * Discards the idle time. - */ - public void updateIdleTime(long idleTime) { - } - - /** - * Returns the minimum distance between updates. - * Get all updates to properly measure moving time. - */ + @Override public int getMinDistance() { return 0; } + + @Override + public void updateIdleTime(long idleTime) { + // Ignore + } } diff --git a/MyTracks/src/com/google/android/apps/mytracks/services/AdaptiveLocationListenerPolicy.java b/MyTracks/src/com/google/android/apps/mytracks/services/AdaptiveLocationListenerPolicy.java index 7d630e995..64ba60ddc 100644 --- a/MyTracks/src/com/google/android/apps/mytracks/services/AdaptiveLocationListenerPolicy.java +++ b/MyTracks/src/com/google/android/apps/mytracks/services/AdaptiveLocationListenerPolicy.java @@ -16,67 +16,58 @@ package com.google.android.apps.mytracks.services; - /** - * A LocationListenerPolicy that will change based on how long the user has been - * stationary. - * - * This policy will dictate a policy based on a min, max and idle time. - * The policy will dictate an interval bounded by min and max whic is half of - * the idle time. - * + * A {@link LocationListenerPolicy} that will change based on how long the user + * has been stationary. This policy will dictate a policy based on a min, max + * and idle time. The policy will dictate an interval bounded by min and max, + * and is half of the idle time. + * * @author Sandor Dornbush */ public class AdaptiveLocationListenerPolicy implements LocationListenerPolicy { - /** - * Smallest interval this policy will dictate, in milliseconds. - */ private final long minInterval; - - /** - * Largest interval this policy will dictate, in milliseconds. - */ private final long maxInterval; - private final int minDistance; - - /** - * The time the user has been at the current location, in milliseconds. - */ + + // The time the user has been idle at the current location, in milliseconds. private long idleTime; /** - * Creates a policy that will be bounded by the given min and max. - * - * @param min Smallest interval this policy will dictate, in milliseconds - * @param max Largest interval this policy will dictate, in milliseconds + * Creates a policy that will be bounded by the given minInterval and + * maxInterval. + * + * @param minInterval the smallest interval this policy will dictate, in + * milliseconds + * @param maxInterval the largest interval this policy will dictate, in + * milliseconds + * @param minDistance the minimum distance in meters */ - public AdaptiveLocationListenerPolicy(long min, long max, int minDistance) { - this.minInterval = min; - this.maxInterval = max; + public AdaptiveLocationListenerPolicy(long minInterval, long maxInterval, int minDistance) { + this.minInterval = minInterval; + this.maxInterval = maxInterval; this.minDistance = minDistance; } - /** - * @return An interval bounded by min and max which is half of the idle time + /* + * Returns an interval half of the idle time, but bounded by minInteval and + * maxInterval. */ + @Override public long getDesiredPollingInterval() { long desiredInterval = idleTime / 2; - // Round to avoid setting the interval too often. + // Round to second to avoid setting the interval too often desiredInterval = (desiredInterval / 1000) * 1000; - return Math.max(Math.min(maxInterval, desiredInterval), - minInterval); + return Math.max(Math.min(maxInterval, desiredInterval), minInterval); } - public void updateIdleTime(long newIdleTime) { - this.idleTime = newIdleTime; - } - - /** - * Returns the minimum distance between updates. - */ + @Override public int getMinDistance() { return minDistance; } + + @Override + public void updateIdleTime(long newIdleTime) { + idleTime = newIdleTime; + } } diff --git a/MyTracks/src/com/google/android/apps/mytracks/services/LocationListenerPolicy.java b/MyTracks/src/com/google/android/apps/mytracks/services/LocationListenerPolicy.java index 1fab6102f..18250f3de 100644 --- a/MyTracks/src/com/google/android/apps/mytracks/services/LocationListenerPolicy.java +++ b/MyTracks/src/com/google/android/apps/mytracks/services/LocationListenerPolicy.java @@ -17,19 +17,18 @@ package com.google.android.apps.mytracks.services; /** - * This is an interface for classes that will manage the location listener policy. - * Different policy options are: - * Absolute - * Addaptive - * + * This is an interface for classes that will manage the location listener + * policy. Different policy options are: {@link AbsoluteLocationListenerPolicy} + * and {@link AdaptiveLocationListenerPolicy}. + * * @author Sandor Dornbush */ public interface LocationListenerPolicy { /** - * Returns the polling time this policy would like at this time. - * - * @return The polling that this policy dictates + * Returns the polling interval this policy would like at this moment. + * + * @return the polling interval */ public long getDesiredPollingInterval(); @@ -39,10 +38,10 @@ public interface LocationListenerPolicy { public int getMinDistance(); /** - * Notifies the amount of time the user has been idle at their current - * location. - * - * @param idleTime The time that the user has been idle at this spot + * Notifies the amount of time the user has been idle at his current location. + * + * @param idleTime the time that the user has been idle at his current + * location */ public void updateIdleTime(long idleTime); }