Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 198fa8ad authored by Roshan Pius's avatar Roshan Pius
Browse files

WifiNetworkSpecifier/Suggestion: Address API council comments 

Modified builder methods to:
a) Add boolean input for all boolean setters.
b) Add a public value for unassigned priority and added IntRange
annotation.

Bug: 128317241
Bug: 128317186
Test: Compiles
Test: ./frameworks/base/wifi/tests/runtest.sh
Change-Id: Iaf9d26ed857fe9337d3e4006c9c894efbcfa32dd
parent 4719ffe5

api/current.txt

+8 −8
Original line number Diff line number Diff line
@@ -30141,8 +30141,8 @@ package android.net.wifi { 
    method @NonNull public android.net.wifi.WifiNetworkSpecifier build();

    method @NonNull public android.net.wifi.WifiNetworkSpecifier.Builder setBssid(@NonNull android.net.MacAddress);

    method @NonNull public android.net.wifi.WifiNetworkSpecifier.Builder setBssidPattern(@NonNull android.net.MacAddress, @NonNull android.net.MacAddress);

    method @NonNull public android.net.wifi.WifiNetworkSpecifier.Builder setIsEnhancedOpen();

    method @NonNull public android.net.wifi.WifiNetworkSpecifier.Builder setIsHiddenSsid();

    method @NonNull public android.net.wifi.WifiNetworkSpecifier.Builder setIsEnhancedOpen(boolean);

    method @NonNull public android.net.wifi.WifiNetworkSpecifier.Builder setIsHiddenSsid(boolean);

    method @NonNull public android.net.wifi.WifiNetworkSpecifier.Builder setSsid(@NonNull String);

    method @NonNull public android.net.wifi.WifiNetworkSpecifier.Builder setSsidPattern(@NonNull android.os.PatternMatcher);

    method @NonNull public android.net.wifi.WifiNetworkSpecifier.Builder setWpa2EnterpriseConfig(@NonNull android.net.wifi.WifiEnterpriseConfig);
@@ -30161,12 +30161,12 @@ package android.net.wifi { 
    ctor public WifiNetworkSuggestion.Builder();

    method @NonNull public android.net.wifi.WifiNetworkSuggestion build();

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setBssid(@NonNull android.net.MacAddress);

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setIsAppInteractionRequired();

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setIsEnhancedOpen();

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setIsHiddenSsid();

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setIsMetered();

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setIsUserInteractionRequired();

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setPriority(int);

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setIsAppInteractionRequired(boolean);

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setIsEnhancedOpen(boolean);

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setIsHiddenSsid(boolean);

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setIsMetered(boolean);

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setIsUserInteractionRequired(boolean);

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setPriority(@IntRange(from=0) int);

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setSsid(@NonNull String);

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setWpa2EnterpriseConfig(@NonNull android.net.wifi.WifiEnterpriseConfig);

    method @NonNull public android.net.wifi.WifiNetworkSuggestion.Builder setWpa2Passphrase(@NonNull String);

wifi/java/android/net/wifi/WifiNetworkSpecifier.java

+8 −4
Original line number Diff line number Diff line
@@ -183,10 +183,12 @@ public final class WifiNetworkSpecifier extends NetworkSpecifier implements Parc 
        /**

         * Specifies whether this represents an Enhanced Open (OWE) network.

         *

         * @param isEnhancedOpen {@code true} to indicate that the network uses enhanced open,

         *                       {@code false} otherwise.

         * @return Instance of {@link Builder} to enable chaining of the builder method.

         */

        public @NonNull Builder setIsEnhancedOpen() {

            mIsEnhancedOpen = true;

        public @NonNull Builder setIsEnhancedOpen(boolean isEnhancedOpen) {

            mIsEnhancedOpen = isEnhancedOpen;

            return this;

        }
@@ -261,10 +263,12 @@ public final class WifiNetworkSpecifier extends NetworkSpecifier implements Parc 
         * hidden networks need to be explicitly probed for.</li>

         * <li>If not set, defaults to false (i.e not a hidden network).</li>

         *

         * @param isHiddenSsid {@code true} to indicate that the network is hidden, {@code false}

         *                     otherwise.

         * @return Instance of {@link Builder} to enable chaining of the builder method.

         */

        public @NonNull Builder setIsHiddenSsid() {

            mIsHiddenSSID = true;

        public @NonNull Builder setIsHiddenSsid(boolean isHiddenSsid) {

            mIsHiddenSSID = isHiddenSsid;

            return this;

        }

wifi/java/android/net/wifi/WifiNetworkSuggestion.java

+22 −11
Original line number Diff line number Diff line
@@ -18,6 +18,7 @@ package android.net.wifi; 


import static com.android.internal.util.Preconditions.checkNotNull;



import android.annotation.IntRange;

import android.annotation.NonNull;

import android.annotation.Nullable;

import android.app.ActivityThread;
@@ -159,10 +160,12 @@ public final class WifiNetworkSuggestion implements Parcelable { 
        /**

         * Specifies whether this represents an Enhanced Open (OWE) network.

         *

         * @param isEnhancedOpen {@code true} to indicate that the network used enhanced open,

         *                       {@code false} otherwise.

         * @return Instance of {@link Builder} to enable chaining of the builder method.

         */

        public @NonNull Builder setIsEnhancedOpen() {

            mIsEnhancedOpen = true;

        public @NonNull Builder setIsEnhancedOpen(boolean isEnhancedOpen) {

            mIsEnhancedOpen = isEnhancedOpen;

            return this;

        }
@@ -235,10 +238,12 @@ public final class WifiNetworkSuggestion implements Parcelable { 
         * <p>

         * <li>If not set, defaults to false (i.e not a hidden network).</li>

         *

         * @param isHiddenSsid {@code true} to indicate that the network is hidden, {@code false}

         *                     otherwise.

         * @return Instance of {@link Builder} to enable chaining of the builder method.

         */

        public @NonNull Builder setIsHiddenSsid() {

            mIsHiddenSSID = true;

        public @NonNull Builder setIsHiddenSsid(boolean isHiddenSsid) {

            mIsHiddenSSID = isHiddenSsid;

            return this;

        }
@@ -253,10 +258,12 @@ public final class WifiNetworkSuggestion implements Parcelable { 
         * <p>

         * <li>If not set, defaults to false (i.e no app interaction required).</li>

         *

         * @param isAppInteractionRequired {@code true} to indicate that app interaction is

         *                                 required, {@code false} otherwise.

         * @return Instance of {@link Builder} to enable chaining of the builder method.

         */

        public @NonNull Builder setIsAppInteractionRequired() {

            mIsAppInteractionRequired = true;

        public @NonNull Builder setIsAppInteractionRequired(boolean isAppInteractionRequired) {

            mIsAppInteractionRequired = isAppInteractionRequired;

            return this;

        }
@@ -265,10 +272,12 @@ public final class WifiNetworkSuggestion implements Parcelable { 
         * <p>

         * <li>If not set, defaults to false (i.e no user interaction required).</li>

         *

         * @param isUserInteractionRequired {@code true} to indicate that user interaction is

         *                                  required, {@code false} otherwise.

         * @return Instance of {@link Builder} to enable chaining of the builder method.

         */

        public @NonNull Builder setIsUserInteractionRequired() {

            mIsUserInteractionRequired = true;

        public @NonNull Builder setIsUserInteractionRequired(boolean isUserInteractionRequired) {

            mIsUserInteractionRequired = isUserInteractionRequired;

            return this;

        }
@@ -283,7 +292,7 @@ public final class WifiNetworkSuggestion implements Parcelable { 
         * @return Instance of {@link Builder} to enable chaining of the builder method.

         * @throws IllegalArgumentException if the priority value is negative.

         */

        public @NonNull Builder setPriority(int priority) {

        public @NonNull Builder setPriority(@IntRange(from = 0) int priority) {

            if (priority < 0) {

                throw new IllegalArgumentException("Invalid priority value " + priority);

            }
@@ -296,10 +305,12 @@ public final class WifiNetworkSuggestion implements Parcelable { 
         * <p>

         * <li>If not set, defaults to false (i.e not metered).</li>

         *

         * @param isMetered {@code true} to indicate that the network is metered, {@code false}

         *                  otherwise.

         * @return Instance of {@link Builder} to enable chaining of the builder method.

         */

        public @NonNull Builder setIsMetered() {

            mIsMetered = true;

        public @NonNull Builder setIsMetered(boolean isMetered) {

            mIsMetered = isMetered;

            return this;

        }

wifi/tests/src/android/net/wifi/WifiNetworkSpecifierTest.java

+5 −5
Original line number Diff line number Diff line
@@ -114,7 +114,7 @@ public class WifiNetworkSpecifierTest { 
                .setSsid(TEST_SSID)

                .setBssid(MacAddress.fromString(TEST_BSSID))

                .setWpa2EnterpriseConfig(enterpriseConfig)

                .setIsHiddenSsid()

                .setIsHiddenSsid(true)

                .build();



        assertTrue(specifier instanceof WifiNetworkSpecifier);
@@ -278,7 +278,7 @@ public class WifiNetworkSpecifierTest { 
        new WifiNetworkSpecifier.Builder()

                .setBssidPattern(MacAddress.fromString(TEST_BSSID_OUI_BASE_ADDRESS),

                        MacAddress.fromString(TEST_BSSID_OUI_MASK))

                .setIsHiddenSsid()

                .setIsHiddenSsid(true)

                .build();

    }
@@ -305,7 +305,7 @@ public class WifiNetworkSpecifierTest { 
    public void testWifiNetworkSpecifierBuilderWithSsidMatchPatternForHiddenNetwork() {

        new WifiNetworkSpecifier.Builder()

                .setSsidPattern(new PatternMatcher(TEST_SSID, PATTERN_PREFIX))

                .setIsHiddenSsid()

                .setIsHiddenSsid(true)

                .build();

    }
@@ -341,14 +341,14 @@ public class WifiNetworkSpecifierTest { 
    /**

     * Ensure {@link WifiNetworkSpecifier.Builder#build()} throws an exception

     * when both {@link WifiNetworkSpecifier.Builder#setWpa3Passphrase(String)} and

     * {@link WifiNetworkSpecifier.Builder#setIsEnhancedOpen()} are invoked.

     * {@link WifiNetworkSpecifier.Builder#setIsEnhancedOpen(boolean)} are invoked.

     */

    @Test(expected = IllegalStateException.class)

    public void testWifiNetworkSpecifierBuilderWithBothWpa3PasphraseAndEnhancedOpen() {

        new WifiNetworkSpecifier.Builder()

                .setSsidPattern(new PatternMatcher(TEST_SSID, PATTERN_LITERAL))

                .setWpa3Passphrase(TEST_PRESHARED_KEY)

                .setIsEnhancedOpen()

                .setIsEnhancedOpen(true)

                .build();

    }

wifi/tests/src/android/net/wifi/WifiNetworkSuggestionTest.java

+8 −8
Original line number Diff line number Diff line
@@ -49,7 +49,7 @@ public class WifiNetworkSuggestionTest { 
    public void testWifiNetworkSuggestionBuilderForOpenNetworkWithReqAppInteraction() {

        WifiNetworkSuggestion suggestion = new WifiNetworkSuggestion.Builder()

                .setSsid(TEST_SSID)

                .setIsAppInteractionRequired()

                .setIsAppInteractionRequired(true)

                .build();



        assertEquals(Process.myUid(), suggestion.suggestorUid);
@@ -74,7 +74,7 @@ public class WifiNetworkSuggestionTest { 
        WifiNetworkSuggestion suggestion = new WifiNetworkSuggestion.Builder()

                .setSsid(TEST_SSID)

                .setWpa2Passphrase(TEST_PRESHARED_KEY)

                .setIsAppInteractionRequired()

                .setIsAppInteractionRequired(true)

                .setPriority(0)

                .build();
@@ -101,8 +101,8 @@ public class WifiNetworkSuggestionTest { 
        WifiNetworkSuggestion suggestion = new WifiNetworkSuggestion.Builder()

                .setSsid(TEST_SSID)

                .setWpa2Passphrase(TEST_PRESHARED_KEY)

                .setIsUserInteractionRequired()

                .setIsMetered()

                .setIsUserInteractionRequired(true)

                .setIsMetered(true)

                .build();



        assertEquals("\"" + TEST_SSID + "\"", suggestion.wifiConfiguration.SSID);
@@ -126,7 +126,7 @@ public class WifiNetworkSuggestionTest { 
        WifiNetworkSuggestion suggestion = new WifiNetworkSuggestion.Builder()

                .setSsid(TEST_SSID)

                .setBssid(MacAddress.fromString(TEST_BSSID))

                .setIsEnhancedOpen()

                .setIsEnhancedOpen(true)

                .build();



        assertEquals("\"" + TEST_SSID + "\"", suggestion.wifiConfiguration.SSID);
@@ -265,7 +265,7 @@ public class WifiNetworkSuggestionTest { 
    public void testWifiNetworkSuggestionBuilderWithInvalidPriority() {

        new WifiNetworkSuggestion.Builder()

                .setSsid(TEST_SSID)

                .setPriority(-1)

                .setPriority(-2)

                .build();

    }
@@ -301,14 +301,14 @@ public class WifiNetworkSuggestionTest { 
    /**

     * Ensure {@link WifiNetworkSuggestion.Builder#build()} throws an exception

     * when both {@link WifiNetworkSuggestion.Builder#setWpa3Passphrase(String)} and

     * {@link WifiNetworkSuggestion.Builder#setIsEnhancedOpen()} are invoked.

     * {@link WifiNetworkSuggestion.Builder#setIsEnhancedOpen(boolean)} are invoked.

     */

    @Test(expected = IllegalStateException.class)

    public void testWifiNetworkSuggestionBuilderWithBothWpa3PasphraseAndEnhancedOpen() {

        new WifiNetworkSuggestion.Builder()

                .setSsid(TEST_SSID)

                .setWpa3Passphrase(TEST_PRESHARED_KEY)

                .setIsEnhancedOpen()

                .setIsEnhancedOpen(true)

                .build();

    }