Clean up ApiFeatures.java

Rename CupcakePlatformAdapter to ApiLevel3Adapter. Rename EclairPlatformAdapter to ApiLevel5Adapter. Rename GingerbreadPlatformAdapter to ApiLevel9Adapter. Rename ApiPlatformAdapter to ApiLevelAdapter.
2011-10-13 17:58:19 -07:00
parent 91b3decf01
commit 167e1e79a8
15 changed files with 47 additions and 37 deletions
@@ -86,7 +86,7 @@ class CheckUnits {
  }

  private static void recordCheckPerformed(SharedPreferences preferences) {
-    ApiFeatures.getInstance().getApiPlatformAdapter().applyPreferenceChanges(
+    ApiFeatures.getInstance().getApiAdapter().applyPreferenceChanges(
        preferences.edit().putBoolean(PREFERENCE_UNITS_CHECKED, true));
  }

@@ -65,7 +65,7 @@ public class DeleteAllTracks extends Handler {
            SharedPreferences.Editor editor = prefs.edit();
            // TODO: Go through data manager
            editor.putLong(context.getString(R.string.selected_track_key), -1);
-            ApiFeatures.getInstance().getApiPlatformAdapter().applyPreferenceChanges(editor);
+            ApiFeatures.getInstance().getApiAdapter().applyPreferenceChanges(editor);
            if (done != null) {
              Handler h = new Handler();
              h.post(done);
@@ -108,7 +108,7 @@ public class DeleteTrack extends Activity
    SharedPreferences preferences = getSharedPreferences(Constants.SETTINGS_NAME, 0);
    if (preferences.getLong(selectedKey, -1) == deleteTrackId) {
      Editor editor = preferences.edit().putLong(selectedKey, -1);
-      ApiFeatures.getInstance().getApiPlatformAdapter().applyPreferenceChanges(editor);
+      ApiFeatures.getInstance().getApiAdapter().applyPreferenceChanges(editor);
    }
  }
 }
@@ -95,7 +95,7 @@ class Eula {
  }

  private static void accept(Activity activity, SharedPreferences preferences) {
-    ApiFeatures.getInstance().getApiPlatformAdapter().applyPreferenceChanges(
+    ApiFeatures.getInstance().getApiAdapter().applyPreferenceChanges(
        preferences.edit().putBoolean(PREFERENCE_EULA_ACCEPTED, true));
    Intent startIntent = new Intent(activity, WelcomeActivity.class);
    activity.startActivityForResult(startIntent, Constants.WELCOME);
@@ -134,7 +134,7 @@ public class MyTracks extends TabActivity implements OnTouchListener {
    super.onCreate(savedInstanceState);
    ApiFeatures apiFeatures = ApiFeatures.getInstance();
    if (!SystemUtils.isRelease(this)) {
-      apiFeatures.getApiPlatformAdapter().enableStrictMode();
+      apiFeatures.getApiAdapter().enableStrictMode();
    }

    tracker = GoogleAnalyticsTracker.getInstance();
@@ -397,7 +397,7 @@ public class TrackDataHub {

    // Save the selection to memory and flush.
    selectedTrackId = trackId;
-    ApiFeatures.getInstance().getApiPlatformAdapter().applyPreferenceChanges(
+    ApiFeatures.getInstance().getApiAdapter().applyPreferenceChanges(
        preferences.edit().putLong(SELECTED_TRACK_KEY, trackId));

    // Force it to reload data from the beginning.
@@ -48,7 +48,7 @@ import java.util.Locale;
 class DocsTagBuilder {
  
  private static final DecimalFormatSymbols FORMAT_SYMBOLS =
-      ApiFeatures.getInstance().getApiPlatformAdapter().getDecimalFormatSymbols(Locale.ENGLISH);
+      ApiFeatures.getInstance().getApiAdapter().getDecimalFormatSymbols(Locale.ENGLISH);
  private static final NumberFormat LARGE_UNIT_FORMAT =
      new DecimalFormat("#,###,###.00", FORMAT_SYMBOLS);
  private static final NumberFormat SMALL_UNIT_FORMAT =
@@ -37,7 +37,7 @@ import com.google.android.apps.mytracks.services.tasks.StatusAnnouncerFactory;
 import com.google.android.apps.mytracks.stats.TripStatistics;
 import com.google.android.apps.mytracks.stats.TripStatisticsBuilder;
 import com.google.android.apps.mytracks.util.ApiFeatures;
-import com.google.android.apps.mytracks.util.ApiPlatformAdapter;
+import com.google.android.apps.mytracks.util.ApiLevelAdapter;
 import com.google.android.apps.mytracks.util.LocationUtils;
 import com.google.android.apps.mytracks.util.StringUtils;
 import com.google.android.maps.mytracks.R;
@@ -485,8 +485,8 @@ public class TrackRecordingService extends Service {
   * Shows the notification message and icon in the notification bar.
   */
  private void showNotification() {
-    final ApiPlatformAdapter apiPlatformAdapter =
-        ApiFeatures.getInstance().getApiPlatformAdapter();
+    final ApiLevelAdapter apiLevelAdapter =
+        ApiFeatures.getInstance().getApiAdapter();
    if (isRecording) {
      Notification notification = new Notification(
          R.drawable.arrow_320, null /* tickerText */,
@@ -497,10 +497,10 @@ public class TrackRecordingService extends Service {
      notification.setLatestEventInfo(this, getString(R.string.app_name),
          getString(R.string.recording_your_track), contentIntent);
      notification.flags += Notification.FLAG_NO_CLEAR;
-      apiPlatformAdapter.startForeground(this, notificationManager, 1,
+      apiLevelAdapter.startForeground(this, notificationManager, 1,
          notification);
    } else {
-      apiPlatformAdapter.stopForeground(this, notificationManager, 1);
+      apiLevelAdapter.stopForeground(this, notificationManager, 1);
    }
  }

@@ -62,7 +62,7 @@ public class ZephyrMessageParser implements MessageParser {
    // 0x1A00316550003162 produces erroneous values for Cadence and needs
    // a workaround based on the stride counter.
    // Firmware values range from field 3 to 10 (inclusive) of the byte buffer.
-    byte[] hardwareFirmwareId = ApiFeatures.getInstance().getApiPlatformAdapter()
+    byte[] hardwareFirmwareId = ApiFeatures.getInstance().getApiAdapter()
        .copyByteArray(buffer, 3, 11);
    Sensor.SensorData.Builder cadence = Sensor.SensorData.newBuilder();

@@ -33,7 +33,7 @@ import android.util.Log;
 public class ApiFeatures {

  /**
-   * The API level of the Android version we're being run under.
+   * The API level of the Android version we are being run under.
   */
  private static final int ANDROID_API_LEVEL = Integer.parseInt(
      Build.VERSION.SDK);
@@ -41,9 +41,9 @@ public class ApiFeatures {
  private static ApiFeatures instance;

  /**
-   * The API platform adapter supported by this system.
+   * The API level adapter for the Android version we are being run under.
   */
-  private ApiPlatformAdapter apiPlatformAdapter;
+  private ApiLevelAdapter apiLevelAdapter;

  /**
   * Returns the singleton instance of this class.
@@ -70,18 +70,18 @@ public class ApiFeatures {
    // It is safe to import unsupported classes as long as we only actually
    // load the class when supported.
    if (getApiLevel() >= 9) {
-      apiPlatformAdapter = new GingerbreadPlatformAdapter();
+      apiLevelAdapter = new ApiLevel9Adapter();
    } else if (getApiLevel() >= 5) {
-      apiPlatformAdapter = new EclairPlatformAdapter();
+      apiLevelAdapter = new ApiLevel5Adapter();
    } else {
-      apiPlatformAdapter = new CupcakePlatformAdapter();
+      apiLevelAdapter = new ApiLevel3Adapter();
    }

-    Log.i(Constants.TAG, "Using platform adapter " + apiPlatformAdapter.getClass());
+    Log.i(Constants.TAG, "Using API level adapter " + apiLevelAdapter.getClass());
  }

-  public ApiPlatformAdapter getApiPlatformAdapter() {
-    return apiPlatformAdapter;
+  public ApiLevelAdapter getApiAdapter() {
+    return apiLevelAdapter;
  }

  // API Level 4 Changes
@@ -29,12 +29,11 @@ import java.text.DecimalFormatSymbols;
 import java.util.Locale;

 /**
- * The Cupcake (API level 3) specific implementation of the
- * {@link ApiPlatformAdapter}.
- * 
+ * API level 3 specific implementation of the {@link ApiLevelAdapter}.
+ *
 * @author Bartlomiej Niechwiej
 */
-public class CupcakePlatformAdapter implements ApiPlatformAdapter {
+public class ApiLevel3Adapter implements ApiLevelAdapter {

  @Override
  public void startForeground(Service service,
@@ -20,12 +20,11 @@ import android.app.NotificationManager;
 import android.app.Service;

 /**
- * The Eclair (API level 5) specific implementation of the
- * {@link ApiPlatformAdapter}.
- * 
+ * API level 5 specific implementation of the {@link ApiLevelAdapter}.
+ *
 * @author Bartlomiej Niechwiej
 */
-public class EclairPlatformAdapter extends CupcakePlatformAdapter {
+public class ApiLevel5Adapter extends ApiLevel3Adapter {

  @Override
  public void startForeground(Service service,
@@ -11,12 +11,11 @@ import java.util.Arrays;
 import java.util.Locale;

 /**
- * The Gingerbread (API level 9) specific implememntation of the
- * {@link ApiPlatformAdapter}.
+ * API level 9 specific implementation of the {@link ApiLevelAdapter}.
 *
 * @author Rodrigo Damazio
 */
-public class GingerbreadPlatformAdapter extends EclairPlatformAdapter {
+public class ApiLevel9Adapter extends ApiLevel5Adapter {
  
  @Override
  public void applyPreferenceChanges(Editor editor) {
@@ -24,15 +24,17 @@ import java.text.DecimalFormatSymbols;
 import java.util.Locale;

 /**
- * A set of methods that may be implemented in a platform specific way. 
+ * A set of methods that may be implemented differently depending on the Android API level. 
 *  
 * @author Bartlomiej Niechwiej
 */
-public interface ApiPlatformAdapter {
+public interface ApiLevelAdapter {
  
  /**
   * Puts the specified service into foreground.
   * 
+   * Due to changes in API level 5.
+   * 
   * @param service the service to be put in foreground.
   * @param notificationManager the notification manager used to post the given
   *        notification.
@@ -44,6 +46,9 @@ public interface ApiPlatformAdapter {
  
  /**
   * Puts the given service into background.
+   * 
+   * Due to changes in API level 5.
+   * 
   * @param service the service to put into background.
   * @param notificationManager the notification manager to user when removing
   *        notifications. 
@@ -56,11 +61,15 @@ public interface ApiPlatformAdapter {
  /**
   * Applies all changes done to the given preferences editor.
   * Changes may or may not be applied immediately.
+   * 
+   * Due to changes in API level 9.
   */
  void applyPreferenceChanges(SharedPreferences.Editor editor);
  
  /**
   * Enables strict mode where supported, only if this is a development build.
+   * 
+   * Due to changes in API level 9.
   */
  void enableStrictMode();
  
@@ -69,6 +78,8 @@ public interface ApiPlatformAdapter {
   * indexes start (inclusive) to end (exclusive). The end index must be less
   * than or equal to input.length.
   *
+   * Due to changes in API level 9.
+   * 
   * @param input the input byte array
   * @param start the start index
   * @param end the end index
@@ -80,6 +91,8 @@ public interface ApiPlatformAdapter {
  /**
   * Gets an instance of {@link DecimalFormatSymbols} for a locale.
   * 
+   * Due to changes in API level 9.
+   *    
   * @param locale the locale
   * @return a new instance of {@link DecimalFormatSymbols}
   */
@@ -65,7 +65,7 @@ public class ApiFeaturesTest extends TestCase {
    }
  }

-  public void testGetApiPlatformAdapter() {
-    assertNotNull(features.getApiPlatformAdapter());
+  public void testGetApiAdapter() {
+    assertNotNull(features.getApiAdapter());
  }
 }