android.net

Class NetworkCapabilities

java.lang.Object

android.net.NetworkCapabilities

public class NetworkCapabilities
extends Object

This class represents the capabilities of a network. This is used both to specify needs to ConnectivityManager and when inspecting a network. Note that this replaces the old ConnectivityManager#TYPE_MOBILE method of network selection. Rather than indicate a need for Wi-Fi because an application needs high bandwidth and risk obselence when a new, fast network appears (like LTE), the application should specify it needs high bandwidth. Similarly if an application needs an unmetered network for a bulk transfer it can specify that rather than assuming all cellular based connections are metered and all Wi-Fi based connections are not.

Field Summary

Fields

Modifier and Type	Field and Description
static int	NET_CAPABILITY_INTERNET Indicates that this network should be able to reach the internet.

Constructor Summary

Constructors

Constructor and Description
NetworkCapabilities() Instantiates a NetworkCapabilities without capabilities.
NetworkCapabilities(int[] capabilities) Instantiates a NetworkCapabilities.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
protected int[]	getCapabilities() Gets the capabilities.
boolean	hasCapability(int capability) Tests for the presence of a capability on this instance.
int	hashCode() Returns a hash code value for the object.
protected void	setCapabilities(int[] capabilities) Sets the capabilities.

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

NET_CAPABILITY_INTERNET

public static final int NET_CAPABILITY_INTERNET

Indicates that this network should be able to reach the internet.

See Also:

Constant Field Values

Constructor Detail

NetworkCapabilities

public NetworkCapabilities()

Instantiates a NetworkCapabilities without capabilities.

NetworkCapabilities

public NetworkCapabilities(int[] capabilities)

Instantiates a NetworkCapabilities.

Parameters:

capabilities - capabilities;

Method Detail

equals

public boolean equals(@Nullable
                      Object obj)

Description copied from class: Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

getCapabilities

protected int[] getCapabilities()

Gets the capabilities.

Returns:

the capabilities.

hasCapability

public boolean hasCapability(int capability)

Tests for the presence of a capability on this instance.

Parameters:

capability - Value is NetworkCapabilities

Returns:

true if set on this instance.

hashCode

public int hashCode()

Description copied from class: Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

setCapabilities

protected void setCapabilities(int[] capabilities)

Sets the capabilities.

Parameters:

capabilities - the capabilities to set.