1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
|
/*
* Copyright (C) 2014 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;
import android.annotation.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;
import java.util.Objects;
/**
* Information which identifies a specific network.
*
* @hide
*/
@SystemApi
// NOTE: Ideally, we would abstract away the details of what identifies a network of a specific
// type, so that all networks appear the same and can be scored without concern to the network type
// itself. However, because no such cross-type identifier currently exists in the Android framework,
// and because systems might obtain information about networks from sources other than Android
// devices, we need to provide identifying details about each specific network type (wifi, cell,
// etc.) so that clients can pull out these details depending on the type of network.
public class NetworkKey implements Parcelable {
/** A wifi network, for which {@link #wifiKey} will be populated. */
public static final int TYPE_WIFI = 1;
/**
* The type of this network.
* @see #TYPE_WIFI
*/
public final int type;
/**
* Information identifying a Wi-Fi network. Only set when {@link #type} equals
* {@link #TYPE_WIFI}.
*/
public final WifiKey wifiKey;
/**
* Construct a new {@link NetworkKey} for a Wi-Fi network.
* @param wifiKey the {@link WifiKey} identifying this Wi-Fi network.
*/
public NetworkKey(WifiKey wifiKey) {
this.type = TYPE_WIFI;
this.wifiKey = wifiKey;
}
private NetworkKey(Parcel in) {
type = in.readInt();
switch (type) {
case TYPE_WIFI:
wifiKey = WifiKey.CREATOR.createFromParcel(in);
break;
default:
throw new IllegalArgumentException("Parcel has unknown type: " + type);
}
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel out, int flags) {
out.writeInt(type);
switch (type) {
case TYPE_WIFI:
wifiKey.writeToParcel(out, flags);
break;
default:
throw new IllegalStateException("NetworkKey has unknown type " + type);
}
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
NetworkKey that = (NetworkKey) o;
return type == that.type && Objects.equals(wifiKey, that.wifiKey);
}
@Override
public int hashCode() {
return Objects.hash(type, wifiKey);
}
@Override
public String toString() {
switch (type) {
case TYPE_WIFI:
return wifiKey.toString();
default:
// Don't throw an exception here in case someone is logging this object in a catch
// block for debugging purposes.
return "InvalidKey";
}
}
public static final Parcelable.Creator<NetworkKey> CREATOR =
new Parcelable.Creator<NetworkKey>() {
@Override
public NetworkKey createFromParcel(Parcel in) {
return new NetworkKey(in);
}
@Override
public NetworkKey[] newArray(int size) {
return new NetworkKey[size];
}
};
}
|