# Print output for @column tags ?> NetworkSliceInfo - Android SDK | Android Developers

Most visited

Recently visited

NetworkSliceInfo

public final class NetworkSliceInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.telephony.data.NetworkSliceInfo


Represents a S-NSSAI as defined in 3GPP TS 24.501, which represents a network slice. There are 2 main fields that define a slice, SliceServiceType and SliceDifferentiator. SliceServiceType defines the type of service provided by the slice, and SliceDifferentiator is used to differentiate between multiple slices of the same type. If the devices is not on HPLMN, the mappedHplmn versions of these 2 fields indicate the corresponding values in HPLMN.

Summary

Nested classes

class NetworkSliceInfo.Builder

Provides a convenient way to set the fields of a NetworkSliceInfo when creating a new instance. 

Constants

int SLICE_DIFFERENTIATOR_NO_SLICE

When set on a Slice Differentiator, this value indicates that there is no corresponding Slice.

int SLICE_SERVICE_TYPE_EMBB

Slice suitable for the handling of 5G enhanced Mobile Broadband.

int SLICE_SERVICE_TYPE_MIOT

Slice suitable for the handling of massive IoT.

int SLICE_SERVICE_TYPE_NONE

Indicates that the service type is not present.

int SLICE_SERVICE_TYPE_URLLC

Slice suitable for the handling of ultra-reliable low latency communications.

int SLICE_STATUS_ALLOWED

The slice is allowed to be used.

int SLICE_STATUS_CONFIGURED

The slice is configured but not allowed or rejected yet.

int SLICE_STATUS_DEFAULT_CONFIGURED

The slice is configured by home operator(HPLMN) in default and is used if configured/allowed slices are not available for the serving PLMN.

int SLICE_STATUS_REJECTED_NOT_AVAILABLE_IN_PLMN

The slice is rejected because not available in PLMN.

int SLICE_STATUS_REJECTED_NOT_AVAILABLE_IN_REGISTERED_AREA

The slice is rejected because not available in registered area.

int SLICE_STATUS_UNKNOWN

The slice status is unknown.

Inherited constants

Fields

public static final Creator<NetworkSliceInfo> CREATOR

Public methods

int describeContents()

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

boolean equals(Object o)

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

int getMappedHplmnSliceDifferentiator()

This Slice Differentiator corresponds to a NetworkSliceInfo (S-NSSAI) of the HPLMN; getSliceDifferentiator() is mapped to this value.

int getMappedHplmnSliceServiceType()

Corresponds to a Slice Info (S-NSSAI) of the HPLMN.

int getSliceDifferentiator()

Identifies the slice from others with the same Slice Service Type.

int getSliceServiceType()

The type of service provided by the slice.

int getStatus()

Field to indicate the current status of the slice.

int hashCode()

Returns a hash code value for the object.

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

SLICE_DIFFERENTIATOR_NO_SLICE

public static final int SLICE_DIFFERENTIATOR_NO_SLICE

When set on a Slice Differentiator, this value indicates that there is no corresponding Slice.

Constant Value: -1 (0xffffffff)

SLICE_SERVICE_TYPE_EMBB

public static final int SLICE_SERVICE_TYPE_EMBB

Slice suitable for the handling of 5G enhanced Mobile Broadband.

Constant Value: 1 (0x00000001)

SLICE_SERVICE_TYPE_MIOT

public static final int SLICE_SERVICE_TYPE_MIOT

Slice suitable for the handling of massive IoT.

Constant Value: 3 (0x00000003)

SLICE_SERVICE_TYPE_NONE

public static final int SLICE_SERVICE_TYPE_NONE

Indicates that the service type is not present.

Constant Value: 0 (0x00000000)

SLICE_SERVICE_TYPE_URLLC

public static final int SLICE_SERVICE_TYPE_URLLC

Slice suitable for the handling of ultra-reliable low latency communications.

Constant Value: 2 (0x00000002)

SLICE_STATUS_ALLOWED

public static final int SLICE_STATUS_ALLOWED

The slice is allowed to be used.

Constant Value: 2 (0x00000002)

SLICE_STATUS_CONFIGURED

public static final int SLICE_STATUS_CONFIGURED

The slice is configured but not allowed or rejected yet.

Constant Value: 1 (0x00000001)

SLICE_STATUS_DEFAULT_CONFIGURED

public static final int SLICE_STATUS_DEFAULT_CONFIGURED

The slice is configured by home operator(HPLMN) in default and is used if configured/allowed slices are not available for the serving PLMN.

Constant Value: 5 (0x00000005)

SLICE_STATUS_REJECTED_NOT_AVAILABLE_IN_PLMN

public static final int SLICE_STATUS_REJECTED_NOT_AVAILABLE_IN_PLMN

The slice is rejected because not available in PLMN.

Constant Value: 3 (0x00000003)

SLICE_STATUS_REJECTED_NOT_AVAILABLE_IN_REGISTERED_AREA

public static final int SLICE_STATUS_REJECTED_NOT_AVAILABLE_IN_REGISTERED_AREA

The slice is rejected because not available in registered area.

Constant Value: 4 (0x00000004)

SLICE_STATUS_UNKNOWN

public static final int SLICE_STATUS_UNKNOWN

The slice status is unknown. This can happen during IWLAN->cellular handover when the NetworkSliceInfo is received over IWLAN.

Constant Value: 0 (0x00000000)

Fields

CREATOR

public static final Creator<NetworkSliceInfo> CREATOR

Public methods

describeContents

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

public boolean equals (Object o)

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.

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

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

getMappedHplmnSliceDifferentiator

public int getMappedHplmnSliceDifferentiator ()

This Slice Differentiator corresponds to a NetworkSliceInfo (S-NSSAI) of the HPLMN; getSliceDifferentiator() is mapped to this value.

Returns SLICE_DIFFERENTIATOR_NO_SLICE if either of the following are true:

see: 3GPP TS 24.501 Section 9.11.2.8.

Returns
int Value is between MIN_SLICE_DIFFERENTIATOR and MAX_SLICE_DIFFERENTIATOR inclusive

getMappedHplmnSliceServiceType

public int getMappedHplmnSliceServiceType ()

Corresponds to a Slice Info (S-NSSAI) of the HPLMN.

see: 3GPP TS 24.501 Section 9.11.2.8.

Returns
int Value is SLICE_SERVICE_TYPE_NONE, SLICE_SERVICE_TYPE_EMBB, SLICE_SERVICE_TYPE_URLLC, or SLICE_SERVICE_TYPE_MIOT

getSliceDifferentiator

public int getSliceDifferentiator ()

Identifies the slice from others with the same Slice Service Type.

Returns SLICE_DIFFERENTIATOR_NO_SLICE if getSliceServiceType() returns SLICE_SERVICE_TYPE_NONE.

see: 3GPP TS 24.501 Section 9.11.2.8.

Returns
int Value is between MIN_SLICE_DIFFERENTIATOR and MAX_SLICE_DIFFERENTIATOR inclusive

getSliceServiceType

public int getSliceServiceType ()

The type of service provided by the slice.

see: 3GPP TS 24.501 Section 9.11.2.8.

Returns
int Value is SLICE_SERVICE_TYPE_NONE, SLICE_SERVICE_TYPE_EMBB, SLICE_SERVICE_TYPE_URLLC, or SLICE_SERVICE_TYPE_MIOT

getStatus

public int getStatus ()

Field to indicate the current status of the slice.

Returns
int the current status for this slice info. Value is SLICE_STATUS_UNKNOWN, SLICE_STATUS_CONFIGURED, SLICE_STATUS_ALLOWED, SLICE_STATUS_REJECTED_NOT_AVAILABLE_IN_PLMN, SLICE_STATUS_REJECTED_NOT_AVAILABLE_IN_REGISTERED_AREA, or SLICE_STATUS_DEFAULT_CONFIGURED

hashCode

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(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 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™ programming language.)

Returns
int a hash code value for this object.

toString

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

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