Add method to convert visible networks into Proto

chrome/android/java/src/org/chromium/chrome/browser/omnibox/geo/VisibleNetworks.java

 // Copyright 2017 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.chrome.browser.omnibox.geo;
 
 import android.support.annotation.IntDef;
 
 import org.chromium.base.ApiCompatibilityUtils;
 
@@ skipping 15 matching lines @@
     @Nullable
     private final VisibleCell mConnectedCell;
     @Nullable
     private final Set<VisibleWifi> mAllVisibleWifis;
     @Nullable
     private final Set<VisibleCell> mAllVisibleCells;
 
     private VisibleNetworks(@Nullable VisibleWifi connectedWifi,
             @Nullable VisibleCell connectedCell, @Nullable Set<VisibleWifi> allVisibleWifis,
             @Nullable Set<VisibleCell> allVisibleCells) {
-        this.mConnectedWifi = connectedWifi;
-        this.mConnectedCell = connectedCell;
-        this.mAllVisibleWifis = allVisibleWifis;
-        this.mAllVisibleCells = allVisibleCells;
+        mConnectedWifi = connectedWifi;
+        mConnectedCell = connectedCell;
+        mAllVisibleWifis = allVisibleWifis;
+        mAllVisibleCells = allVisibleCells;
     }
 
     public static VisibleNetworks create(@Nullable VisibleWifi connectedWifi,
             @Nullable VisibleCell connectedCell, @Nullable Set<VisibleWifi> allVisibleWifis,
             @Nullable Set<VisibleCell> allVisibleCells) {
         return new VisibleNetworks(connectedWifi, connectedCell, allVisibleWifis, allVisibleCells);
     }
 
     /**
      * Returns the connected {@link VisibleWifi} or null if the connected wifi is unknown.
@@ skipping 44 matching lines @@
      * Compares the specified object with this VisibleNetworks for equality.  Returns
      * {@code true} if the given object is a VisibleNetworks and has identical values for
      * all of its fields.
      */
     @Override
     public boolean equals(Object object) {
         if (!(object instanceof VisibleNetworks)) {
             return false;
         }
         VisibleNetworks that = (VisibleNetworks) object;
-        return ApiCompatibilityUtils.objectEquals(this.mConnectedWifi, that.connectedWifi())
-                && ApiCompatibilityUtils.objectEquals(this.mConnectedCell, that.connectedCell())
-                && ApiCompatibilityUtils.objectEquals(this.mAllVisibleWifis, that.allVisibleWifis())
-                && ApiCompatibilityUtils.objectEquals(
-                           this.mAllVisibleCells, that.allVisibleCells());
+        return ApiCompatibilityUtils.objectEquals(mConnectedWifi, that.connectedWifi())
+                && ApiCompatibilityUtils.objectEquals(mConnectedCell, that.connectedCell())
+                && ApiCompatibilityUtils.objectEquals(mAllVisibleWifis, that.allVisibleWifis())
+                && ApiCompatibilityUtils.objectEquals(mAllVisibleCells, that.allVisibleCells());
     }
 
     private static int objectsHashCode(Object o) {
         return o != null ? o.hashCode() : 0;
     }
 
     private static int objectsHash(Object... a) {
         return Arrays.hashCode(a);
     }
 
     @Override
     public int hashCode() {
-        return objectsHash(this.mConnectedWifi, this.mConnectedCell,
-                objectsHashCode(this.mAllVisibleWifis), objectsHashCode(this.mAllVisibleCells));
+        return objectsHash(mConnectedWifi, mConnectedCell, objectsHashCode(mAllVisibleWifis),
+                objectsHashCode(mAllVisibleCells));
     }
 
     /**
      * Specification of a visible wifi.
      */
     public static class VisibleWifi {
         public static final VisibleWifi NO_WIFI_INFO = VisibleWifi.create(null, null, null, null);
 
         @Nullable
         private final String mSsid;
         @Nullable
         private final String mBssid;
         @Nullable
         private final Integer mLevel;
         @Nullable
         private final Long mTimestampMs;
 
         private VisibleWifi(@Nullable String ssid, @Nullable String bssid, @Nullable Integer level,
                 @Nullable Long timestampMs) {
-            this.mSsid = ssid;
-            this.mBssid = bssid;
-            this.mLevel = level;
-            this.mTimestampMs = timestampMs;
+            mSsid = ssid;
+            mBssid = bssid;
+            mLevel = level;
+            mTimestampMs = timestampMs;
         }
 
         public static VisibleWifi create(@Nullable String ssid, @Nullable String bssid,
                 @Nullable Integer level, @Nullable Long timestampMs) {
             return new VisibleWifi(ssid, bssid, level, timestampMs);
         }
 
         /**
          * Returns the SSID of the visible Wifi, or null if unknown.
          */
@@ skipping 31 matching lines @@
          * {@code true} if the given object is a VisibleWifi and has identical values for
          * all of its fields except level and timestampMs.
          */
         @Override
         public boolean equals(Object object) {
             if (!(object instanceof VisibleWifi)) {
                 return false;
             }
 
             VisibleWifi that = (VisibleWifi) object;
-            return ApiCompatibilityUtils.objectEquals(this.mSsid, that.ssid())
-                    && ApiCompatibilityUtils.objectEquals(this.mBssid, that.bssid());
+            return ApiCompatibilityUtils.objectEquals(mSsid, that.ssid())
+                    && ApiCompatibilityUtils.objectEquals(mBssid, that.bssid());
         }
 
         @Override
         public int hashCode() {
-            return VisibleNetworks.objectsHash(this.mSsid, this.mBssid);
+            return VisibleNetworks.objectsHash(mSsid, mBssid);
+        }
+
+        /**
+         * Encodes a VisibleWifi into its corresponding PartnerLocationDescriptor.VisibleNetwork
+         * proto.
+         */
+        public PartnerLocationDescriptor.VisibleNetwork toProto(boolean connected) {
+            PartnerLocationDescriptor.VisibleNetwork visibleNetwork =
+                    new PartnerLocationDescriptor.VisibleNetwork();
+
+            PartnerLocationDescriptor.VisibleNetwork.WiFi wifi =
+                    new PartnerLocationDescriptor.VisibleNetwork.WiFi();
+
+            String bssid = bssid();
+            if (bssid != null) {
+                wifi.bssid = bssid();

[Ted C, 2017/05/17 17:44:25]

what is the default value for wifi.bssid?  Is it not null?

Should we just do wifi.bssid = bssid(); ?

If we can't, we should reuse the local var above.

Same general comment as below

If clang format allows it, we should do these on a single line

if (bssid != null) wifi.bssid = bssid;

[lbargu, 2017/05/18 12:42:48]

Sorry, forgot this is nano protos. Should be ok to assign directly. Also added
tests to verify cases where data is missing (empty networks).

+            }
+            Integer level = level();
+            if (level != null) {
+                wifi.levelDbm = level();
+            }
+            visibleNetwork.wifi = wifi;
+
+            Long timestampMs = timestampMs();
+            if (timestampMs != null) {
+                visibleNetwork.timestampMs = timestampMs;
+            }
+            visibleNetwork.connected = connected;
+            return visibleNetwork;

[dougt, 2017/05/17 20:51:17]

two questions:

Can any of these accessors return null and is it bad to assign null to values in
the descriptor?  I ask because this code gets alot simpler if either the
accessors never return null or if it is okay to assign null to the descriptor. 
For example:


        public PartnerLocationDescriptor.VisibleNetwork toProto(boolean
connected) {
            PartnerLocationDescriptor.VisibleNetwork visibleNetwork =
                    new PartnerLocationDescriptor.VisibleNetwork();

            PartnerLocationDescriptor.VisibleNetwork.WiFi wifi =
                    new PartnerLocationDescriptor.VisibleNetwork.WiFi();

            wifi.bssid = bssid();
            wifi.levelDbm = level();
            visibleNetwork.wifi = wifi;

            visibleNetwork.timestampMs = timestampMs();
            visibleNetwork.connected = connected;
            return visibleNetwork;
        }

[lbargu, 2017/05/18 12:42:48]

Done.

         }
     }
 
     /**
      * Specification of a visible cell.
      */
     public static class VisibleCell {
         public static final VisibleCell UNKNOWN_VISIBLE_CELL =
                 VisibleCell.builder(VisibleCell.UNKNOWN_RADIO_TYPE).build();
         public static final VisibleCell UNKNOWN_MISSING_LOCATION_PERMISSION_VISIBLE_CELL =
@@ skipping 31 matching lines @@
         @Nullable
         private final Integer mPrimaryScramblingCode;
         @Nullable
         private final Integer mPhysicalCellId;
         @Nullable
         private final Integer mTrackingAreaCode;
         @Nullable
         private Long mTimestampMs;
 
         private VisibleCell(Builder builder) {
-            this.mRadioType = builder.mRadioType;
-            this.mCellId = builder.mCellId;
-            this.mLocationAreaCode = builder.mLocationAreaCode;
-            this.mMobileCountryCode = builder.mMobileCountryCode;
-            this.mMobileNetworkCode = builder.mMobileNetworkCode;
-            this.mPrimaryScramblingCode = builder.mPrimaryScramblingCode;
-            this.mPhysicalCellId = builder.mPhysicalCellId;
-            this.mTrackingAreaCode = builder.mTrackingAreaCode;
-            this.mTimestampMs = builder.mTimestampMs;
+            mRadioType = builder.mRadioType;
+            mCellId = builder.mCellId;
+            mLocationAreaCode = builder.mLocationAreaCode;
+            mMobileCountryCode = builder.mMobileCountryCode;
+            mMobileNetworkCode = builder.mMobileNetworkCode;
+            mPrimaryScramblingCode = builder.mPrimaryScramblingCode;
+            mPhysicalCellId = builder.mPhysicalCellId;
+            mTrackingAreaCode = builder.mTrackingAreaCode;
+            mTimestampMs = builder.mTimestampMs;
         }
 
         /**
          * Returns the radio type of the visible cell.
          */
         @RadioType
         public int radioType() {
             return mRadioType;
         }
 
@@ skipping 66 matching lines @@
          * Compares the specified object with this VisibleCell for equality.  Returns
          * {@code true} if the given object is a VisibleWifi and has identical values for
          * all of its fields except timestampMs.
          */
         @Override
         public boolean equals(Object object) {
             if (!(object instanceof VisibleCell)) {
                 return false;
             }
             VisibleCell that = (VisibleCell) object;
-            return ApiCompatibilityUtils.objectEquals(this.mRadioType, that.radioType())
-                    && ApiCompatibilityUtils.objectEquals(this.mCellId, that.cellId())
+            return ApiCompatibilityUtils.objectEquals(mRadioType, that.radioType())
+                    && ApiCompatibilityUtils.objectEquals(mCellId, that.cellId())
                     && ApiCompatibilityUtils.objectEquals(
-                               this.mLocationAreaCode, that.locationAreaCode())
+                               mLocationAreaCode, that.locationAreaCode())
                     && ApiCompatibilityUtils.objectEquals(
-                               this.mMobileCountryCode, that.mobileCountryCode())
+                               mMobileCountryCode, that.mobileCountryCode())
                     && ApiCompatibilityUtils.objectEquals(
-                               this.mMobileNetworkCode, that.mobileNetworkCode())
+                               mMobileNetworkCode, that.mobileNetworkCode())
                     && ApiCompatibilityUtils.objectEquals(
-                               this.mPrimaryScramblingCode, that.primaryScramblingCode())
+                               mPrimaryScramblingCode, that.primaryScramblingCode())
+                    && ApiCompatibilityUtils.objectEquals(mPhysicalCellId, that.physicalCellId())
                     && ApiCompatibilityUtils.objectEquals(
-                               this.mPhysicalCellId, that.physicalCellId())
-                    && ApiCompatibilityUtils.objectEquals(
-                               this.mTrackingAreaCode, that.trackingAreaCode());
+                               mTrackingAreaCode, that.trackingAreaCode());
         }
 
         @Override
         public int hashCode() {
-            return VisibleNetworks.objectsHash(this.mRadioType, this.mCellId,
-                    this.mLocationAreaCode, this.mMobileCountryCode, this.mMobileNetworkCode,
-                    this.mPrimaryScramblingCode, this.mPhysicalCellId, this.mTrackingAreaCode);
+            return VisibleNetworks.objectsHash(mRadioType, mCellId, mLocationAreaCode,
+                    mMobileCountryCode, mMobileNetworkCode, mPrimaryScramblingCode, mPhysicalCellId,
+                    mTrackingAreaCode);
         }
 
         /**
+         * Encodes a VisibleCell into its corresponding PartnerLocationDescriptor.VisibleNetwork
+         * proto.
+         */
+        public PartnerLocationDescriptor.VisibleNetwork toProto(boolean connected) {
+            PartnerLocationDescriptor.VisibleNetwork visibleNetwork =
+                    new PartnerLocationDescriptor.VisibleNetwork();
+
+            PartnerLocationDescriptor.VisibleNetwork.Cell cell =
+                    new PartnerLocationDescriptor.VisibleNetwork.Cell();
+
+            switch (radioType()) {
+                case VisibleCell.CDMA_RADIO_TYPE:
+                    cell.type = PartnerLocationDescriptor.VisibleNetwork.Cell.CDMA;
+                    break;
+                case VisibleCell.GSM_RADIO_TYPE:
+                    cell.type = PartnerLocationDescriptor.VisibleNetwork.Cell.GSM;
+                    break;
+                case VisibleCell.LTE_RADIO_TYPE:
+                    cell.type = PartnerLocationDescriptor.VisibleNetwork.Cell.LTE;
+                    break;
+                case VisibleCell.WCDMA_RADIO_TYPE:
+                    cell.type = PartnerLocationDescriptor.VisibleNetwork.Cell.WCDMA;
+                    break;
+                case VisibleCell.UNKNOWN_RADIO_TYPE:
+                    cell.type = PartnerLocationDescriptor.VisibleNetwork.Cell.UNKNOWN;
+                    break;
+                case VisibleCell.UNKNOWN_MISSING_LOCATION_PERMISSION_RADIO_TYPE:
+                    cell.type = PartnerLocationDescriptor.VisibleNetwork.Cell.UNKNOWN;
+                    break;
+                default:

[Ted C, 2017/05/17 17:44:25]

should we just fall through these?

case VisibleCell.UNKNOWN_RADIO_TYPE:
case VisibleCell.UNKNOWN_MISSING_LOCATION_PERMISSION_RADIO_TYPE:
default:

[lbargu, 2017/05/18 12:42:48]

Done.

+                    cell.type = PartnerLocationDescriptor.VisibleNetwork.Cell.UNKNOWN;
+                    break;
+            }
+
+            Integer cellId = cellId();
+            if (cellId != null) {
+                cell.cellId = cellId;

[dougt, 2017/05/17 20:51:17]

same nullable question here.

[lbargu, 2017/05/18 12:42:48]

Done.

+            }
+            Integer locationAreaCode = locationAreaCode();
+            if (locationAreaCode != null) {
+                cell.locationAreaCode = locationAreaCode;
+            }
+            Integer mobileCountryCode = mobileCountryCode();
+            if (mobileCountryCode != null) {
+                cell.mobileCountryCode = mobileCountryCode;
+            }
+            Integer mobileNetworkCode = mobileNetworkCode();
+            if (mobileNetworkCode != null) {
+                cell.mobileNetworkCode = mobileNetworkCode;
+            }
+            Integer primaryScramblingCode = primaryScramblingCode();
+            if (primaryScramblingCode != null) {
+                cell.primaryScramblingCode = primaryScramblingCode;
+            }
+            Integer physicalCellId = physicalCellId();
+            if (physicalCellId != null) {
+                cell.physicalCellId = physicalCellId;
+            }
+            Integer trackingAreaCode = trackingAreaCode();
+            if (trackingAreaCode != null) {
+                cell.trackingAreaCode = trackingAreaCode;
+            }
+
+            visibleNetwork.cell = cell;
+
+            Long timestampMs = timestampMs();
+            if (timestampMs != null) {
+                visibleNetwork.timestampMs = timestampMs;
+            }
+            visibleNetwork.connected = connected;
+            return visibleNetwork;
+        }
+
+        /**
          * A {@link VisibleCell} builder.
          */
         public static class Builder {
             @RadioType
             private int mRadioType;
             @Nullable
             private Integer mCellId;
             @Nullable
             private Integer mLocationAreaCode;
             @Nullable
@@ skipping 53 matching lines @@
                 mTimestampMs = timestampMs;
                 return this;
             }
 
             public VisibleCell build() {
                 return new VisibleCell(this);
             }
         }
     }
 }