BarringInfo.BarringServiceInfo

public static final class BarringInfo.BarringServiceInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.telephony.BarringInfo.BarringServiceInfo


Describe the current barring configuration of a cell

Summary

Constants

int BARRING_TYPE_CONDITIONAL

The service may be barred based on additional factors

int BARRING_TYPE_NONE

Barring is inactive

int BARRING_TYPE_UNCONDITIONAL

The service is barred

int BARRING_TYPE_UNKNOWN

If a modem does not report barring info, then the barring type will be UNKNOWN

Inherited constants

Fields

public static final Creator<BarringInfo.BarringServiceInfo> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object rhs)

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

int getBarringType()
int getConditionalBarringFactor()
int getConditionalBarringTimeSeconds()
int hashCode()

Returns a hash code value for the object.

boolean isBarred()

Return whether a service is currently barred based on the BarringInfo

boolean isConditionallyBarred()
String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

BARRING_TYPE_CONDITIONAL

Added in API level 30
public static final int BARRING_TYPE_CONDITIONAL

The service may be barred based on additional factors

Constant Value: 1 (0x00000001)

BARRING_TYPE_NONE

Added in API level 30
public static final int BARRING_TYPE_NONE

Barring is inactive

Constant Value: 0 (0x00000000)

BARRING_TYPE_UNCONDITIONAL

Added in API level 30
public static final int BARRING_TYPE_UNCONDITIONAL

The service is barred

Constant Value: 2 (0x00000002)

BARRING_TYPE_UNKNOWN

Added in API level 30
public static final int BARRING_TYPE_UNKNOWN

If a modem does not report barring info, then the barring type will be UNKNOWN

Constant Value: -1 (0xffffffff)

Fields

CREATOR

Added in API level 30
public static final Creator<BarringInfo.BarringServiceInfo> CREATOR

Public methods

describeContents

Added in API level 30
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 30
public boolean equals (Object rhs)

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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
rhs Object: the reference object with which to compare.

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

getBarringType

Added in API level 30
public int getBarringType ()

Returns
int Value is BARRING_TYPE_NONE, BARRING_TYPE_UNCONDITIONAL, BARRING_TYPE_CONDITIONAL, or BARRING_TYPE_UNKNOWN

getConditionalBarringFactor

Added in API level 30
public int getConditionalBarringFactor ()

Returns
int the conditional barring factor as a percentage 0-100, which is the probability of a random device being barred for the service type.

getConditionalBarringTimeSeconds

Added in API level 30
public int getConditionalBarringTimeSeconds ()

Returns
int the conditional barring time seconds, which is the interval between successive evaluations for conditional barring based on the barring factor.

hashCode

Added in API level 30
public int hashCode ()

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 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 equals 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.

Returns
int a hash code value for this object.

isBarred

Added in API level 30
public boolean isBarred ()

Return whether a service is currently barred based on the BarringInfo

Returns
boolean true if the service is currently being barred, otherwise false

isConditionallyBarred

Added in API level 30
public boolean isConditionallyBarred ()

Returns
boolean true if the conditional barring parameters have resulted in the service being barred; false if the service has either not been evaluated for conditional barring or has been evaluated and isn't barred.

toString

Added in API level 30
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 30
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES