Disambiguate NetworkCallback JavaDoc. am: 15874cd

am: c8a0754

* commit 'c8a0754b3d98e90a869acb9dcc8ca8ae40bcbde1':
  Disambiguate NetworkCallback JavaDoc.

Change-Id: Ibf47574237ea8467d8e536395d580bac9f8fea36
This commit is contained in:
Lorenzo Colitti
2016-04-15 09:54:58 +00:00
committed by android-build-merger

View File

@@ -1131,7 +1131,8 @@ public class ConnectivityManager {
* implementation+feature combination, except that the value {@code -1} * implementation+feature combination, except that the value {@code -1}
* always indicates failure. * always indicates failure.
* *
* @deprecated Deprecated in favor of the cleaner {@link #unregisterNetworkCallback} API. * @deprecated Deprecated in favor of the cleaner
* {@link #unregisterNetworkCallback(NetworkCallback)} API.
* In {@link VERSION_CODES#M}, and above, this method is unsupported and will * In {@link VERSION_CODES#M}, and above, this method is unsupported and will
* throw {@code UnsupportedOperationException} if called. * throw {@code UnsupportedOperationException} if called.
*/ */
@@ -2814,7 +2815,7 @@ public class ConnectivityManager {
* Request a network to satisfy a set of {@link android.net.NetworkCapabilities}. * Request a network to satisfy a set of {@link android.net.NetworkCapabilities}.
* *
* This {@link NetworkRequest} will live until released via * This {@link NetworkRequest} will live until released via
* {@link #unregisterNetworkCallback} or the calling application exits. * {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits.
* Status of the request can be followed by listening to the various * Status of the request can be followed by listening to the various
* callbacks described in {@link NetworkCallback}. The {@link Network} * callbacks described in {@link NetworkCallback}. The {@link Network}
* can be used to direct traffic to the network. * can be used to direct traffic to the network.
@@ -2851,7 +2852,7 @@ public class ConnectivityManager {
* This function behaves identically to the non-timedout version, but if a suitable * This function behaves identically to the non-timedout version, but if a suitable
* network is not found within the given time (in milliseconds) the * network is not found within the given time (in milliseconds) the
* {@link NetworkCallback#unavailable} callback is called. The request must * {@link NetworkCallback#unavailable} callback is called. The request must
* still be released normally by calling {@link unregisterNetworkCallback}. * still be released normally by calling {@link unregisterNetworkCallback(NetworkCallback)}.
* *
* <p>This method requires the caller to hold either the * <p>This method requires the caller to hold either the
* {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission * {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
@@ -2959,7 +2960,8 @@ public class ConnectivityManager {
/** /**
* Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)} * Removes a request made via {@link #requestNetwork(NetworkRequest, android.app.PendingIntent)}
* <p> * <p>
* This method has the same behavior as {@link #unregisterNetworkCallback} with respect to * This method has the same behavior as
* {@link #unregisterNetworkCallback(android.app.PendingIntent)} with respect to
* releasing network resources and disconnecting. * releasing network resources and disconnecting.
* *
* @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the * @param operation A PendingIntent equal (as defined by {@link Intent#filterEquals}) to the
@@ -2985,7 +2987,7 @@ public class ConnectivityManager {
/** /**
* Registers to receive notifications about all networks which satisfy the given * Registers to receive notifications about all networks which satisfy the given
* {@link NetworkRequest}. The callbacks will continue to be called until * {@link NetworkRequest}. The callbacks will continue to be called until
* either the application exits or {@link #unregisterNetworkCallback} is called * either the application exits or link #unregisterNetworkCallback(NetworkCallback)} is called.
* <p>This method requires the caller to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* *
@@ -3038,9 +3040,9 @@ public class ConnectivityManager {
} }
/** /**
* Registers to receive notifications about whichever network currently satisfies the * Registers to receive notifications about changes in the system default network. The callbacks
* system default {@link NetworkRequest}. The callbacks will continue to be called until * will continue to be called until either the application exits or
* either the application exits or {@link #unregisterNetworkCallback} is called * {@link #unregisterNetworkCallback(NetworkCallback)} is called.
* <p>This method requires the caller to hold the permission * <p>This method requires the caller to hold the permission
* {@link android.Manifest.permission#ACCESS_NETWORK_STATE}. * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.
* *
@@ -3063,8 +3065,9 @@ public class ConnectivityManager {
* is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying
* network connection for updated bandwidth information. The caller will be notified via * network connection for updated bandwidth information. The caller will be notified via
* {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this
* method assumes that the caller has previously called {@link #registerNetworkCallback} to * method assumes that the caller has previously called
* listen for network changes. * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} to listen for network
* changes.
* *
* @param network {@link Network} specifying which network you're interested. * @param network {@link Network} specifying which network you're interested.
* @return {@code true} on success, {@code false} if the {@link Network} is no longer valid. * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
@@ -3079,8 +3082,9 @@ public class ConnectivityManager {
/** /**
* Unregisters callbacks about and possibly releases networks originating from * Unregisters callbacks about and possibly releases networks originating from
* {@link #requestNetwork(NetworkRequest, NetworkCallback)} and {@link #registerNetworkCallback} * {@link #requestNetwork(NetworkRequest, NetworkCallback)} and
* calls. If the given {@code NetworkCallback} had previously been used with * {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} calls.
* If the given {@code NetworkCallback} had previously been used with
* {@code #requestNetwork}, any networks that had been connected to only to satisfy that request * {@code #requestNetwork}, any networks that had been connected to only to satisfy that request
* will be disconnected. * will be disconnected.
* *