SdkController: Refactor Emulator + Listener names

Simple rename refactoring in the lib:
- Emulator => EmulatorConnection
- OnEmulatorListener => EmulatorListener

Change-Id: I0827b564dd7edec065c634d0860014cb0e15af35

4 files changed, 60 insertions, 56 deletions

diff --git a/apps/SdkController/SdkControllerLib/src/com/android/tools/sdkcontroller/lib/Emulator.java b/apps/SdkController/SdkControllerLib/src/com/android/tools/sdkcontroller/lib/EmulatorConnection.java
index d1c9669..8bf1fb2 100755
--- a/apps/SdkController/SdkControllerLib/src/com/android/tools/sdkcontroller/lib/Emulator.java
+++ b/apps/SdkController/SdkControllerLib/src/com/android/tools/sdkcontroller/lib/EmulatorConnection.java
@@ -34,8 +34,8 @@ import android.util.Log;
  * an event channel that is intended for sending notification messages (events)

  * to the emulator.

  * <p/>

- * Emulator is considered to be "connected" when both channels are connected.

- * Emulator is considered to be "disconnected" when connection with any of the

+ * EmulatorConnection is considered to be "connected" when both channels are connected.

+ * EmulatorConnection is considered to be "disconnected" when connection with any of the

  * channels is lost.

  * <p/>

  * Instance of this class is operational only for a single connection with the

@@ -45,16 +45,16 @@ import android.util.Log;
  * Note that connection with the device over TCP port forwarding is extremely

  * fragile at the moment. For whatever reason the connection is even more

  * fragile if device uses asynchronous sockets (based on java.nio API). So, to

- * address this issue Emulator class implements two types of connections. One is

+ * address this issue EmulatorConnection class implements two types of connections. One is

  * using synchronous sockets, and another is using asynchronous sockets. The

- * type of connection is selected when Emulator instance is created (see

- * comments to Emulator's constructor).

+ * type of connection is selected when EmulatorConnection instance is created (see

+ * comments to EmulatorConnection's constructor).

  * <p/>

  * According to the exchange protocol with the emulator, queries, responses to

  * the queries, and notification messages are all zero-terminated strings.

  */

-public class Emulator {

-    /** Defines connection types supported by the Emulator class. */

+public class EmulatorConnection {

+    /** Defines connection types supported by the EmulatorConnection class. */

     public enum EmulatorConnectionType {

         /** Use asynchronous connection (based on java.nio API). */

         ASYNC_CONNECTION,

@@ -67,9 +67,9 @@ public class Emulator {
     /** TCP port reserved for the multitouch emulation. */

     public static final int MULTITOUCH_PORT = 1969;

     /** Tag for logging messages. */

-    private static final String TAG = "Emulator";

-    /** Emulator events listener. */

-    private OnEmulatorListener mListener;

+    private static final String TAG = "EmulatorConnection";

+    /** EmulatorConnection events listener. */

+    private EmulatorListener mListener;

     /** I/O selector (looper). */

     private Selector mSelector;

     /** Server socket channel. */

@@ -508,31 +508,31 @@ public class Emulator {
     } // EmulatorChannel

 

     /***************************************************************************

-     * Emulator public API

+     * EmulatorConnection public API

      **************************************************************************/

 

     /**

-     * Constructs Emulator instance.

+     * Constructs EmulatorConnection instance.

      *

      * @param port TCP port where emulator connects.

      * @param ctype Defines connection type to use (sync / async). See comments

-     *            to Emulator class for more info.

+     *            to EmulatorConnection class for more info.

      * @throws IOException

      */

-    public Emulator(int port, EmulatorConnectionType ctype) throws IOException {

+    public EmulatorConnection(int port, EmulatorConnectionType ctype) throws IOException {

         constructEmulator(port, ctype);

     }

 

     /**

-     * Constructs Emulator instance.

+     * Constructs EmulatorConnection instance.

      *

      * @param port TCP port where emulator connects.

      * @param ctype Defines connection type to use (sync / async). See comments

-     *            to Emulator class for more info.

-     * @param listener Emulator event listener.

+     *            to EmulatorConnection class for more info.

+     * @param listener EmulatorConnection event listener.

      * @throws IOException

      */

-    public Emulator(int port, EmulatorConnectionType ctype, OnEmulatorListener listener)

+    public EmulatorConnection(int port, EmulatorConnectionType ctype, EmulatorListener listener)

             throws IOException {

         mListener = listener;

         constructEmulator(port, ctype);

@@ -548,11 +548,11 @@ public class Emulator {
     }

 

     /**

-     * Constructs Emulator instance.

+     * Constructs EmulatorConnection instance.

      *

      * @param port TCP port where emulator connects.

      * @param ctype Defines connection type to use (sync / async). See comments

-     *            to Emulator class for more info.

+     *            to EmulatorConnection class for more info.

      * @throws IOException

      */

     private void constructEmulator(int port, EmulatorConnectionType ctype) throws IOException {

@@ -571,7 +571,7 @@ public class Emulator {
         // Register 'accept' I/O on the server socket.

         mServerSocket.register(mSelector, SelectionKey.OP_ACCEPT);

 

-        Logv("Emulator listener is created for port " + port);

+        Logv("EmulatorConnection listener is created for port " + port);

         // Start I/O looper and dispatcher.

         new Thread(new Runnable() {

             @Override

@@ -594,7 +594,7 @@ public class Emulator {
                 onLostConnection();

             }

         } else {

-            Logw("Attempt to send '" + msg + "' to a disconnected Emulator");

+            Logw("Attempt to send '" + msg + "' to a disconnected EmulatorConnection");

         }

     }

 

@@ -605,7 +605,7 @@ public class Emulator {
      * @param listener Listener to set. Passing null with this parameter will

      *            remove the current listener (if there was one).

      */

-    public void setOnEmulatorListener(OnEmulatorListener listener) {

+    public void setEmulatorListener(EmulatorListener listener) {

         synchronized (this) {

             mListener = listener;

         }

@@ -620,7 +620,7 @@ public class Emulator {
     }

 

     /***************************************************************************

-     * Emulator events

+     * EmulatorConnection events

      **************************************************************************/

 

     /**

@@ -629,7 +629,7 @@ public class Emulator {
      * this method returns.

      */

     private void onConnected() {

-        OnEmulatorListener listener;

+        EmulatorListener listener;

         synchronized (this) {

             listener = mListener;

         }

@@ -644,7 +644,7 @@ public class Emulator {
      * be "on hold" until this method returns.

      */

     private void onDisconnected() {

-        OnEmulatorListener listener;

+        EmulatorListener listener;

         synchronized (this) {

             listener = mListener;

         }

@@ -664,7 +664,7 @@ public class Emulator {
      *         "ok|ko[:reply data]"

      */

     private String onQuery(String query, String param) {

-        OnEmulatorListener listener;

+        EmulatorListener listener;

         synchronized (this) {

             listener = mListener;

         }

@@ -685,7 +685,7 @@ public class Emulator {
      *         "ok|ko[:reply data]"

      */

     private String onBlobQuery(byte[] array) {

-        OnEmulatorListener listener;

+        EmulatorListener listener;

         synchronized (this) {

             listener = mListener;

         }

@@ -697,7 +697,7 @@ public class Emulator {
     }

 

     /***************************************************************************

-     * Emulator implementation

+     * EmulatorConnection implementation

      **************************************************************************/

 

     /**

@@ -705,7 +705,7 @@ public class Emulator {
      */

     private void runIOLooper() {

         try {

-            Logv("Waiting on Emulator to connect...");

+            Logv("Waiting on EmulatorConnection to connect...");

             // Check mExitIoLoop before calling 'select', and after in order to

             // detect condition when mSelector has been waken up to exit the

             // I/O loop.

@@ -764,7 +764,7 @@ public class Emulator {
         if (mEventChannel != null && mQueryChannel != null) {

             // We don't accept any more connections after both channels were

             // connected.

-            Loge("Emulator is connecting to the already connected instance.");

+            Loge("EmulatorConnection is connecting to the already connected instance.");

             channel.close();

             return;

         }

@@ -820,7 +820,7 @@ public class Emulator {
         if (mEventChannel != null && mQueryChannel != null) {

             // When both, query and event channels are connected, the emulator

             // is considered to be connected.

-            Logv("... Emulator is connected.");

+            Logv("... EmulatorConnection is connected.");

             mIsConnected = true;

             onConnected();

         }

diff --git a/apps/SdkController/SdkControllerLib/src/com/android/tools/sdkcontroller/lib/OnEmulatorListener.java b/apps/SdkController/SdkControllerLib/src/com/android/tools/sdkcontroller/lib/EmulatorListener.java
index 8d4dffa..7a5c1af 100644
--- a/apps/SdkController/SdkControllerLib/src/com/android/tools/sdkcontroller/lib/OnEmulatorListener.java
+++ b/apps/SdkController/SdkControllerLib/src/com/android/tools/sdkcontroller/lib/EmulatorListener.java
@@ -18,10 +18,10 @@ package com.android.tools.sdkcontroller.lib;
 
 /**
  * Encapsulates a listener to emulator events. An object implementing this
- * interface must be registered with the Emulator instance via
- * setOnEmulatorListener method of the Emulator class.
+ * interface must be registered with the EmulatorConnection instance via
+ * setEmulatorListener method of the EmulatorConnection class.
  */
-public interface OnEmulatorListener {
+public interface EmulatorListener {
     /**
      * Called when emulator is connected. NOTE: This method is called from the
      * I/O loop, so all communication with the emulator will be "on hold" until
diff --git a/apps/SdkController/SdkControllerMultitouch/src/com/android/tools/sdkcontroller/sdkcontrollermultitouch/SdkControllerMultitouchActivity.java b/apps/SdkController/SdkControllerMultitouch/src/com/android/tools/sdkcontroller/sdkcontrollermultitouch/SdkControllerMultitouchActivity.java
index 5d5f2ef..1318a68 100644
--- a/apps/SdkController/SdkControllerMultitouch/src/com/android/tools/sdkcontroller/sdkcontrollermultitouch/SdkControllerMultitouchActivity.java
+++ b/apps/SdkController/SdkControllerMultitouch/src/com/android/tools/sdkcontroller/sdkcontrollermultitouch/SdkControllerMultitouchActivity.java
@@ -30,9 +30,9 @@ import android.view.View;
 import android.view.View.OnTouchListener;
 import android.view.WindowManager;
 
-import com.android.tools.sdkcontroller.lib.Emulator;
-import com.android.tools.sdkcontroller.lib.Emulator.EmulatorConnectionType;
-import com.android.tools.sdkcontroller.lib.OnEmulatorListener;
+import com.android.tools.sdkcontroller.lib.EmulatorConnection;
+import com.android.tools.sdkcontroller.lib.EmulatorConnection.EmulatorConnectionType;
+import com.android.tools.sdkcontroller.lib.EmulatorListener;
 
 /**
  * Encapsulates an application that monitors multi-touch activities on a device,
@@ -40,7 +40,7 @@ import com.android.tools.sdkcontroller.lib.OnEmulatorListener;
  * machine. This application is used to provide a realistic multi-touch
  * emulation in Android Emulator.
  */
-public class SdkControllerMultitouchActivity extends Activity implements OnEmulatorListener {
+public class SdkControllerMultitouchActivity extends Activity implements EmulatorListener {
     /** Tag for logging messages. */
     private static final String TAG = "SdkControllerMultitouch";
     /** Received frame is JPEG image. */
@@ -51,7 +51,7 @@ public class SdkControllerMultitouchActivity extends Activity implements OnEmula
     private static final int FRAME_RGB888 = 3;
 
     /** TCP over USB connection to the emulator. */
-    private Emulator mEmulator;
+    private EmulatorConnection mEmulator;
     /** View for this application. */
     private MultiTouchView mView;
     /** Listener to touch events. */
@@ -132,8 +132,9 @@ public class SdkControllerMultitouchActivity extends Activity implements OnEmula
 
         // Instantiate emulator connector.
         try {
-            mEmulator = new Emulator(Emulator.MULTITOUCH_PORT,
-                    EmulatorConnectionType.SYNC_CONNECTION, this);
+            mEmulator = new EmulatorConnection(EmulatorConnection.MULTITOUCH_PORT,
+                                               EmulatorConnectionType.SYNC_CONNECTION,
+                                               this);
         } catch (IOException e) {
             Loge("Exception while creating server socket: " + e.getMessage());
             finish();
@@ -146,7 +147,7 @@ public class SdkControllerMultitouchActivity extends Activity implements OnEmula
         super.onPause();
 
         if (mEmulator != null) {
-            mEmulator.setOnEmulatorListener(null);
+            mEmulator.setEmulatorListener(null);
             mEmulator.disconnect();
             mEmulator = null;
         }
@@ -183,7 +184,7 @@ public class SdkControllerMultitouchActivity extends Activity implements OnEmula
     }
 
     /***************************************************************************
-     * OnEmulatorListener implementation
+     * EmulatorListener implementation
      **************************************************************************/
 
     /**
@@ -211,8 +212,9 @@ public class SdkControllerMultitouchActivity extends Activity implements OnEmula
 
         // Instantiate emulator connector for the next client.
         try {
-            mEmulator = new Emulator(Emulator.MULTITOUCH_PORT,
-                    EmulatorConnectionType.SYNC_CONNECTION, this);
+            mEmulator = new EmulatorConnection(EmulatorConnection.MULTITOUCH_PORT,
+                                               EmulatorConnectionType.SYNC_CONNECTION,
+                                               this);
         } catch (IOException e) {
             Loge("Exception while recreating server socket: " + e.getMessage());
             finish();
diff --git a/apps/SdkController/SdkControllerSensor/src/com/android/tools/sdkcontroller/sdkcontrollersensor/SdkControllerSensorActivity.java b/apps/SdkController/SdkControllerSensor/src/com/android/tools/sdkcontroller/sdkcontrollersensor/SdkControllerSensorActivity.java
index 1e7d970..d640f2b 100755
--- a/apps/SdkController/SdkControllerSensor/src/com/android/tools/sdkcontroller/sdkcontrollersensor/SdkControllerSensorActivity.java
+++ b/apps/SdkController/SdkControllerSensor/src/com/android/tools/sdkcontroller/sdkcontrollersensor/SdkControllerSensorActivity.java
@@ -34,9 +34,9 @@ import android.widget.CompoundButton;
 import android.view.LayoutInflater;
 import android.util.Log;
 
-import com.android.tools.sdkcontroller.lib.Emulator;
-import com.android.tools.sdkcontroller.lib.Emulator.EmulatorConnectionType;
-import com.android.tools.sdkcontroller.lib.OnEmulatorListener;
+import com.android.tools.sdkcontroller.lib.EmulatorConnection;
+import com.android.tools.sdkcontroller.lib.EmulatorConnection.EmulatorConnectionType;
+import com.android.tools.sdkcontroller.lib.EmulatorListener;
 
 /**
  * Encapsulates an application that monitors all sensors available on a device,
@@ -44,12 +44,12 @@ import com.android.tools.sdkcontroller.lib.OnEmulatorListener;
  * on the host machine. This application is used to provide a realistic sensor
  * emulation in Android Emulator.
  */
-public class SdkControllerSensorActivity extends Activity implements OnEmulatorListener {
+public class SdkControllerSensorActivity extends Activity implements EmulatorListener {
     /** Tag for logging messages. */
     private static final String TAG = "SdkControllerSensor";
 
     /** TCP over USB connection to the emulator. */
-    private Emulator mEmulator;
+    private EmulatorConnection mEmulator;
     /** Array containing monitored sensors. */
     private List<MonitoredSensor> mSensors;
     /** Controls displayed list of sensors. */
@@ -371,8 +371,9 @@ public class SdkControllerSensorActivity extends Activity implements OnEmulatorL
             // Sensor emulator starts very early during emulator startup. So, as
             // discussed in comments to Emulator class, we must use synchronous
             // type of connection with the emulator.
-            mEmulator = new Emulator(Emulator.SENSORS_PORT, EmulatorConnectionType.SYNC_CONNECTION,
-                    this);
+            mEmulator = new EmulatorConnection(EmulatorConnection.SENSORS_PORT,
+                                               EmulatorConnectionType.SYNC_CONNECTION,
+                                               this);
         } catch (IOException e) {
             Loge("Exception while creating server socket: " + e.getMessage());
             finish();
@@ -389,7 +390,7 @@ public class SdkControllerSensorActivity extends Activity implements OnEmulatorL
     }
 
     /***************************************************************************
-     * OnEmulatorListener implementation
+     * EmulatorListener implementation
      **************************************************************************/
 
     /**
@@ -415,8 +416,9 @@ public class SdkControllerSensorActivity extends Activity implements OnEmulatorL
 
         // Instantiate emulator connector for the next client.
         try {
-            mEmulator = new Emulator(Emulator.SENSORS_PORT, EmulatorConnectionType.SYNC_CONNECTION,
-                    this);
+            mEmulator = new EmulatorConnection(EmulatorConnection.SENSORS_PORT,
+                                               EmulatorConnectionType.SYNC_CONNECTION,
+                                               this);
         } catch (IOException e) {
             Loge("Exception while creating server socket: " + e.getMessage());
             finish();