android/net/wifi/nl80211/PnoNetwork.java

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.net.wifi.nl80211;

import android.annotation.NonNull;
import android.annotation.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;

import java.util.Arrays;
import java.util.Objects;

/**
 * Configuration for a PNO (preferred network offload) network used in {@link PnoSettings}. A PNO
 * network allows configuration of a specific network to search for.
 *
 * @hide
 */
@SystemApi
public final class PnoNetwork implements Parcelable {
    private boolean mIsHidden;
    private byte[] mSsid;
    private int[] mFrequencies;

    /**
     * Indicates whether the PNO network configuration is for a hidden SSID - i.e. a network which
     * does not broadcast its SSID and must be queried explicitly.
     *
     * @return True if the configuration is for a hidden network, false otherwise.
     */
    public boolean isHidden() {
        return mIsHidden;
    }

    /**
     * Configure whether the PNO network configuration is for a hidden SSID - i.e. a network which
     * does not broadcast its SSID and must be queried explicitly.
     *
     * @param isHidden True if the configuration is for a hidden network, false otherwise.
     */
    public void setHidden(boolean isHidden) {
        mIsHidden = isHidden;
    }

    /**
     * Get the raw bytes for the SSID of the PNO network being scanned for.
     *
     * @return A byte array.
     */
    @NonNull public byte[] getSsid() {
        return mSsid;
    }

    /**
     * Set the raw bytes for the SSID of the PNO network being scanned for.
     *
     * @param ssid A byte array.
     */
    public void setSsid(@NonNull byte[] ssid) {
        if (ssid == null) {
            throw new IllegalArgumentException("null argument");
        }
        this.mSsid = ssid;
    }

    /**
     * Get the frequencies (in MHz) on which to PNO scan for the current network is being searched
     * for. A null return (i.e. no frequencies configured) indicates that the network is search for
     * on all supported frequencies.
     *
     * @return A array of frequencies (in MHz), a null indicates no configured frequencies.
     */
    @NonNull public int[] getFrequenciesMhz() {
        return mFrequencies;
    }

    /**
     * Set the frequencies (in MHz) on which to PNO scan for the current network is being searched
     * for. A null configuration (i.e. no frequencies configured) indicates that the network is
     * search for on all supported frequencies.
     *
     * @param frequenciesMhz an array of frequencies (in MHz), null indicating no configured
     *                       frequencies.
     */
    public void setFrequenciesMhz(@NonNull int[] frequenciesMhz) {
        if (frequenciesMhz == null) {
            throw new IllegalArgumentException("null argument");
        }
        this.mFrequencies = frequenciesMhz;
    }

    /** Construct an uninitialized PnoNetwork object */
    public PnoNetwork() { }

    /** override comparator */
    @Override
    public boolean equals(Object rhs) {
        if (this == rhs) return true;
        if (!(rhs instanceof PnoNetwork)) {
            return false;
        }
        PnoNetwork network = (PnoNetwork) rhs;
        return Arrays.equals(mSsid, network.mSsid)
                && Arrays.equals(mFrequencies, network.mFrequencies)
                && mIsHidden == network.mIsHidden;
    }

    /** override hash code */
    @Override
    public int hashCode() {
        return Objects.hash(
                mIsHidden,
                Arrays.hashCode(mSsid),
                Arrays.hashCode(mFrequencies));
    }

    /** implement Parcelable interface */
    @Override
    public int describeContents() {
        return 0;
    }

    /**
     * implement Parcelable interface
     * |flag| is ignored.
     */
    @Override
    public void writeToParcel(@NonNull Parcel out, int flags) {
        out.writeInt(mIsHidden ? 1 : 0);
        out.writeByteArray(mSsid);
        out.writeIntArray(mFrequencies);
    }

    /** implement Parcelable interface */
    @NonNull public static final Parcelable.Creator<PnoNetwork> CREATOR =
            new Parcelable.Creator<PnoNetwork>() {
        @Override
        public PnoNetwork createFromParcel(Parcel in) {
            PnoNetwork result = new PnoNetwork();
            result.mIsHidden = in.readInt() != 0 ? true : false;
            result.mSsid = in.createByteArray();
            if (result.mSsid == null) {
                result.mSsid = new byte[0];
            }
            result.mFrequencies = in.createIntArray();
            if (result.mFrequencies == null) {
                result.mFrequencies = new int[0];
            }
            return result;
        }

        @Override
        public PnoNetwork[] newArray(int size) {
            return new PnoNetwork[size];
        }
    };
}