telephony/java/android/telephony/PreciseDataConnectionState.java - LeafOS-Project/android_frameworks_base - Gitiles

 /*
  * 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.telephony;

 import android.annotation.NonNull;
 import android.annotation.Nullable;
 import android.annotation.SystemApi;
 import android.annotation.TestApi;
 import android.compat.Compatibility;
 import android.compat.annotation.ChangeId;
 import android.compat.annotation.EnabledAfter;
 import android.compat.annotation.UnsupportedAppUsage;
 import android.net.LinkProperties;
 import android.os.Build;
 import android.os.Parcel;
 import android.os.Parcelable;
 import android.telephony.Annotation.ApnType;
 import android.telephony.Annotation.DataFailureCause;
 import android.telephony.Annotation.DataState;
 import android.telephony.Annotation.NetworkType;
 import android.telephony.data.ApnSetting;

 import java.util.Objects;


 /**
  * Contains precise data connection state.
  *
  * The following data connection information is included in returned PreciseDataConnectionState:
  *
  * <ul>
  *   <li>Data connection state.
  *   <li>Network type of the connection.
  *   <li>APN types.
  *   <li>APN.
  *   <li>The properties of the network link.
  *   <li>Data connection fail cause.
  * </ul>
  *
  */
 public final class PreciseDataConnectionState implements Parcelable {
     private final @DataState int mState;
     private final @NetworkType int mNetworkType;
     private final @DataFailureCause int mFailCause;
     private final LinkProperties mLinkProperties;
     private final ApnSetting mApnSetting;

     /**
      * Constructor
      *
      * @deprecated this constructor has been superseded and should not be used.
      * @hide
      */
     @TestApi
     @Deprecated
     @UnsupportedAppUsage // (maxTargetSdk = Build.VERSION_CODES.Q)
     // FIXME: figure out how to remove the UnsupportedAppUsage and delete this constructor
     public PreciseDataConnectionState(@DataState int state,
                                       @NetworkType int networkType,
                                       @ApnType int apnTypes, @NonNull String apn,
                                       @Nullable LinkProperties linkProperties,
                                       @DataFailureCause int failCause) {
         this(state, networkType, linkProperties, failCause, new ApnSetting.Builder()
                 .setApnTypeBitmask(apnTypes)
                 .setApnName(apn)
                 .build());
     }


     /**
      * Constructor of PreciseDataConnectionState
      *
      * @param state The state of the data connection
      * @param networkType The access network that is/would carry this data connection
      * @param linkProperties If the data connection is connected, the properties of the connection
      * @param failCause In case a procedure related to this data connection fails, a non-zero error
      *        code indicating the cause of the failure.
      * @param apnSetting If there is a valid APN for this Data Connection, then the APN Settings;
      *        if there is no valid APN setting for the specific type, then this will be null
      */
     private PreciseDataConnectionState(@DataState int state,
                                       @NetworkType int networkType,
                                       @Nullable LinkProperties linkProperties,
                                       @DataFailureCause int failCause,
                                       @Nullable ApnSetting apnSetting) {
         mState = state;
         mNetworkType = networkType;
         mLinkProperties = linkProperties;
         mFailCause = failCause;
         mApnSetting = apnSetting;
     }

     /**
      * Construct a PreciseDataConnectionState object from the given parcel.
      *
      * @hide
      */
     private PreciseDataConnectionState(Parcel in) {
         mState = in.readInt();
         mNetworkType = in.readInt();
         mLinkProperties = in.readParcelable(LinkProperties.class.getClassLoader());
         mFailCause = in.readInt();
         mApnSetting = in.readParcelable(ApnSetting.class.getClassLoader());
     }

     /**
      * Used for checking if the SDK version for
      * {@code PreciseDataConnectionState#getDataConnectionState} is above Q.
      */
     @ChangeId
     @EnabledAfter(targetSdkVersion = Build.VERSION_CODES.Q)
     private static final long GET_DATA_CONNECTION_STATE_R_VERSION = 148535736L;

     /**
      * Returns the state of data connection that supported the apn types returned by
      * {@link #getDataConnectionApnTypeBitMask()}
      *
      * @deprecated use {@link #getState()}
      * @hide
      */
     @Deprecated
     @SystemApi
     public @DataState int getDataConnectionState() {
         if (mState == TelephonyManager.DATA_DISCONNECTING
                 && !Compatibility.isChangeEnabled(GET_DATA_CONNECTION_STATE_R_VERSION)) {
             return TelephonyManager.DATA_CONNECTED;
         }

         return mState;
     }

     /**
      * Returns the high-level state of this data connection.
      */
     public @DataState int getState() {
         return mState;
     }

     /**
      * Get the network type associated with this data connection.
      *
      * @return The current/latest (radio) bearer technology that carries this data connection.
      * For a variety of reasons, the network type can change during the life of the data
      * connection, and this information is not reliable unless the physical link is currently
      * active; (there is currently no mechanism to know whether the physical link is active at
      * any given moment). Thus, this value is generally correct but may not be relied-upon to
      * represent the status of the radio bearer at any given moment.
      */
     public @NetworkType int getNetworkType() {
         return mNetworkType;
     }

     /**
      * Returns the APN types mapped to this data connection.
      *
      * @deprecated use {@link #getApnSetting()}
      * @hide
      */
     @Deprecated
     @SystemApi
     public @ApnType int getDataConnectionApnTypeBitMask() {
         return (mApnSetting != null) ? mApnSetting.getApnTypeBitmask() : ApnSetting.TYPE_NONE;
     }

     /**
      * Returns APN of this data connection.
      *
      * @deprecated use {@link #getApnSetting()}
      * @hide
      */
     @NonNull
     @SystemApi
     @Deprecated
     public String getDataConnectionApn() {
         return (mApnSetting != null) ? mApnSetting.getApnName() : "";
     }

     /**
      * Get the properties of the network link {@link LinkProperties}.
      */
     @Nullable
     public LinkProperties getLinkProperties() {
         return mLinkProperties;
     }

     /**
      * Returns the cause code generated by the most recent state change.
      *
      * @deprecated use {@link #getLastCauseCode()}
      * @hide
      */
     @Deprecated
     @SystemApi
     public int getDataConnectionFailCause() {
         return mFailCause;
     }

     /**
      * Returns the cause code generated by the most recent state change.
      *
      * Return the cause code for the most recent change in {@link #getState}. In the event of an
      * error, this cause code will be non-zero.
      */
     public @DataFailureCause int getLastCauseCode() {
         return mFailCause;
     }

     /**
      * Return the APN Settings for this data connection.
      *
      * @return the ApnSetting that was used to configure this data connection.
      */
     public @Nullable ApnSetting getApnSetting() {
         return mApnSetting;
     }

     @Override
     public int describeContents() {
         return 0;
     }

     @Override
     public void writeToParcel(@NonNull Parcel out, int flags) {
         out.writeInt(mState);
         out.writeInt(mNetworkType);
         out.writeParcelable(mLinkProperties, flags);
         out.writeInt(mFailCause);
         out.writeParcelable(mApnSetting, flags);
     }

     public static final @NonNull Parcelable.Creator<PreciseDataConnectionState> CREATOR
             = new Parcelable.Creator<PreciseDataConnectionState>() {

         public PreciseDataConnectionState createFromParcel(Parcel in) {
             return new PreciseDataConnectionState(in);
         }

         public PreciseDataConnectionState[] newArray(int size) {
             return new PreciseDataConnectionState[size];
         }
     };

     @Override
     public int hashCode() {
         return Objects.hash(mState, mNetworkType, mFailCause, mLinkProperties, mApnSetting);
     }


     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
         if (o == null || getClass() != o.getClass()) return false;
         PreciseDataConnectionState that = (PreciseDataConnectionState) o;
         return mState == that.mState
                 && mNetworkType == that.mNetworkType
                 && mFailCause == that.mFailCause
                 && Objects.equals(mLinkProperties, that.mLinkProperties)
                 && Objects.equals(mApnSetting, that.mApnSetting);
     }

     @NonNull
     @Override
     public String toString() {
         StringBuilder sb = new StringBuilder();

         sb.append("Data Connection state: " + mState);
         sb.append(", Network type: " + mNetworkType);
         sb.append(", APN types: " + ApnSetting.getApnTypesStringFromBitmask(
                 getDataConnectionApnTypeBitMask()));
         sb.append(", APN: " + getDataConnectionApn());
         sb.append(", Link properties: " + mLinkProperties);
         sb.append(", Fail cause: " + DataFailCause.toString(mFailCause));
         sb.append(", Apn Setting: " + mApnSetting);

         return sb.toString();
     }

     /**
      * {@link PreciseDataConnectionState} builder
      *
      * @hide
      */
     public static final class Builder {
         /** The state of the data connection */
         private @DataState int mState = TelephonyManager.DATA_UNKNOWN;

         /** The network type associated with this data connection */
         private @NetworkType int mNetworkType = TelephonyManager.NETWORK_TYPE_UNKNOWN;

         /** If the data connection is connected, the properties of the connection */
         private @Nullable LinkProperties mLinkProperties = null;

         /**
          * In case a procedure related to this data connection fails, a non-zero error code
          * indicating the cause of the failure.
          */
         private @DataFailureCause int mFailCause = DataFailCause.NONE;

         /** The APN Setting for this data connection */
         private @Nullable ApnSetting mApnSetting = null;

         /**
          * Set the state of the data connection.
          *
          * @param state The state of the data connection
          * @return The builder
          */
         public Builder setState(@DataState int state) {
             mState = state;
             return this;
         }

         /**
          * Set the network type associated with this data connection.
          *
          * @param networkType The network type
          * @return The builder
          */
         public Builder setNetworkType(@NetworkType int networkType) {
             mNetworkType = networkType;
             return this;
         }

         /**
          * Set the link properties of the connection.
          *
          * @param linkProperties Link properties
          * @return The builder
          */
         public Builder setLinkProperties(@NonNull LinkProperties linkProperties) {
             mLinkProperties = linkProperties;
             return this;
         }

         /**
          * Set the fail cause of the data connection.
          *
          * @param failCause In case a procedure related to this data connection fails, a non-zero
          * error code indicating the cause of the failure.
          * @return The builder
          */
         public Builder setFailCause(@DataFailureCause int failCause) {
             mFailCause = failCause;
             return this;
         }

         /**
          * Set the APN Setting for this data connection.
          *
          * @param apnSetting APN setting
          * @return This builder
          */
         public Builder setApnSetting(@NonNull ApnSetting apnSetting) {
             mApnSetting = apnSetting;
             return this;
         }

         /**
          * Build the {@link PreciseDataConnectionState} instance.
          *
          * @return The {@link PreciseDataConnectionState} instance
          */
         public PreciseDataConnectionState build() {
             return new PreciseDataConnectionState(mState, mNetworkType, mLinkProperties, mFailCause,
                     mApnSetting);
         }
     }
 }
	/*
	* 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.telephony;

	import android.annotation.NonNull;
	import android.annotation.Nullable;
	import android.annotation.SystemApi;
	import android.annotation.TestApi;
	import android.compat.Compatibility;
	import android.compat.annotation.ChangeId;
	import android.compat.annotation.EnabledAfter;
	import android.compat.annotation.UnsupportedAppUsage;
	import android.net.LinkProperties;
	import android.os.Build;
	import android.os.Parcel;
	import android.os.Parcelable;
	import android.telephony.Annotation.ApnType;
	import android.telephony.Annotation.DataFailureCause;
	import android.telephony.Annotation.DataState;
	import android.telephony.Annotation.NetworkType;
	import android.telephony.data.ApnSetting;

	import java.util.Objects;


	/**
	* Contains precise data connection state.
	*
	* The following data connection information is included in returned PreciseDataConnectionState:
	*
	* <ul>
	* <li>Data connection state.
	* <li>Network type of the connection.
	* <li>APN types.
	* <li>APN.
	* <li>The properties of the network link.
	* <li>Data connection fail cause.
	* </ul>
	*
	*/
	public final class PreciseDataConnectionState implements Parcelable {
	private final @DataState int mState;
	private final @NetworkType int mNetworkType;
	private final @DataFailureCause int mFailCause;
	private final LinkProperties mLinkProperties;
	private final ApnSetting mApnSetting;

	/**
	* Constructor
	*
	* @deprecated this constructor has been superseded and should not be used.
	* @hide
	*/
	@TestApi
	@Deprecated
	@UnsupportedAppUsage // (maxTargetSdk = Build.VERSION_CODES.Q)
	// FIXME: figure out how to remove the UnsupportedAppUsage and delete this constructor
	public PreciseDataConnectionState(@DataState int state,
	@NetworkType int networkType,
	@ApnType int apnTypes, @NonNull String apn,
	@Nullable LinkProperties linkProperties,
	@DataFailureCause int failCause) {
	this(state, networkType, linkProperties, failCause, new ApnSetting.Builder()
	.setApnTypeBitmask(apnTypes)
	.setApnName(apn)
	.build());
	}


	/**
	* Constructor of PreciseDataConnectionState
	*
	* @param state The state of the data connection
	* @param networkType The access network that is/would carry this data connection
	* @param linkProperties If the data connection is connected, the properties of the connection
	* @param failCause In case a procedure related to this data connection fails, a non-zero error
	* code indicating the cause of the failure.
	* @param apnSetting If there is a valid APN for this Data Connection, then the APN Settings;
	* if there is no valid APN setting for the specific type, then this will be null
	*/
	private PreciseDataConnectionState(@DataState int state,
	@NetworkType int networkType,
	@Nullable LinkProperties linkProperties,
	@DataFailureCause int failCause,
	@Nullable ApnSetting apnSetting) {
	mState = state;
	mNetworkType = networkType;
	mLinkProperties = linkProperties;
	mFailCause = failCause;
	mApnSetting = apnSetting;
	}

	/**
	* Construct a PreciseDataConnectionState object from the given parcel.
	*
	* @hide
	*/
	private PreciseDataConnectionState(Parcel in) {
	mState = in.readInt();
	mNetworkType = in.readInt();
	mLinkProperties = in.readParcelable(LinkProperties.class.getClassLoader());
	mFailCause = in.readInt();
	mApnSetting = in.readParcelable(ApnSetting.class.getClassLoader());
	}

	/**
	* Used for checking if the SDK version for
	* {@code PreciseDataConnectionState#getDataConnectionState} is above Q.
	*/
	@ChangeId
	@EnabledAfter(targetSdkVersion = Build.VERSION_CODES.Q)
	private static final long GET_DATA_CONNECTION_STATE_R_VERSION = 148535736L;

	/**
	* Returns the state of data connection that supported the apn types returned by
	* {@link #getDataConnectionApnTypeBitMask()}
	*
	* @deprecated use {@link #getState()}
	* @hide
	*/
	@Deprecated
	@SystemApi
	public @DataState int getDataConnectionState() {
	if (mState == TelephonyManager.DATA_DISCONNECTING
	&& !Compatibility.isChangeEnabled(GET_DATA_CONNECTION_STATE_R_VERSION)) {
	return TelephonyManager.DATA_CONNECTED;
	}

	return mState;
	}

	/**
	* Returns the high-level state of this data connection.
	*/
	public @DataState int getState() {
	return mState;
	}

	/**
	* Get the network type associated with this data connection.
	*
	* @return The current/latest (radio) bearer technology that carries this data connection.
	* For a variety of reasons, the network type can change during the life of the data
	* connection, and this information is not reliable unless the physical link is currently
	* active; (there is currently no mechanism to know whether the physical link is active at
	* any given moment). Thus, this value is generally correct but may not be relied-upon to
	* represent the status of the radio bearer at any given moment.
	*/
	public @NetworkType int getNetworkType() {
	return mNetworkType;
	}

	/**
	* Returns the APN types mapped to this data connection.
	*
	* @deprecated use {@link #getApnSetting()}
	* @hide
	*/
	@Deprecated
	@SystemApi
	public @ApnType int getDataConnectionApnTypeBitMask() {
	return (mApnSetting != null) ? mApnSetting.getApnTypeBitmask() : ApnSetting.TYPE_NONE;
	}

	/**
	* Returns APN of this data connection.
	*
	* @deprecated use {@link #getApnSetting()}
	* @hide
	*/
	@NonNull
	@SystemApi
	@Deprecated
	public String getDataConnectionApn() {
	return (mApnSetting != null) ? mApnSetting.getApnName() : "";
	}

	/**
	* Get the properties of the network link {@link LinkProperties}.
	*/
	@Nullable
	public LinkProperties getLinkProperties() {
	return mLinkProperties;
	}

	/**
	* Returns the cause code generated by the most recent state change.
	*
	* @deprecated use {@link #getLastCauseCode()}
	* @hide
	*/
	@Deprecated
	@SystemApi
	public int getDataConnectionFailCause() {
	return mFailCause;
	}

	/**
	* Returns the cause code generated by the most recent state change.
	*
	* Return the cause code for the most recent change in {@link #getState}. In the event of an
	* error, this cause code will be non-zero.
	*/
	public @DataFailureCause int getLastCauseCode() {
	return mFailCause;
	}

	/**
	* Return the APN Settings for this data connection.
	*
	* @return the ApnSetting that was used to configure this data connection.
	*/
	public @Nullable ApnSetting getApnSetting() {
	return mApnSetting;
	}

	@Override
	public int describeContents() {
	return 0;
	}

	@Override
	public void writeToParcel(@NonNull Parcel out, int flags) {
	out.writeInt(mState);
	out.writeInt(mNetworkType);
	out.writeParcelable(mLinkProperties, flags);
	out.writeInt(mFailCause);
	out.writeParcelable(mApnSetting, flags);
	}

	public static final @NonNull Parcelable.Creator<PreciseDataConnectionState> CREATOR
	= new Parcelable.Creator<PreciseDataConnectionState>() {

	public PreciseDataConnectionState createFromParcel(Parcel in) {
	return new PreciseDataConnectionState(in);
	}

	public PreciseDataConnectionState[] newArray(int size) {
	return new PreciseDataConnectionState[size];
	}
	};

	@Override
	public int hashCode() {
	return Objects.hash(mState, mNetworkType, mFailCause, mLinkProperties, mApnSetting);
	}


	@Override
	public boolean equals(Object o) {
	if (this == o) return true;
	if (o == null \|\| getClass() != o.getClass()) return false;
	PreciseDataConnectionState that = (PreciseDataConnectionState) o;
	return mState == that.mState
	&& mNetworkType == that.mNetworkType
	&& mFailCause == that.mFailCause
	&& Objects.equals(mLinkProperties, that.mLinkProperties)
	&& Objects.equals(mApnSetting, that.mApnSetting);
	}

	@NonNull
	@Override
	public String toString() {
	StringBuilder sb = new StringBuilder();

	sb.append("Data Connection state: " + mState);
	sb.append(", Network type: " + mNetworkType);
	sb.append(", APN types: " + ApnSetting.getApnTypesStringFromBitmask(
	getDataConnectionApnTypeBitMask()));
	sb.append(", APN: " + getDataConnectionApn());
	sb.append(", Link properties: " + mLinkProperties);
	sb.append(", Fail cause: " + DataFailCause.toString(mFailCause));
	sb.append(", Apn Setting: " + mApnSetting);

	return sb.toString();
	}

	/**
	* {@link PreciseDataConnectionState} builder
	*
	* @hide
	*/
	public static final class Builder {
	/** The state of the data connection */
	private @DataState int mState = TelephonyManager.DATA_UNKNOWN;

	/** The network type associated with this data connection */
	private @NetworkType int mNetworkType = TelephonyManager.NETWORK_TYPE_UNKNOWN;

	/** If the data connection is connected, the properties of the connection */
	private @Nullable LinkProperties mLinkProperties = null;

	/**
	* In case a procedure related to this data connection fails, a non-zero error code
	* indicating the cause of the failure.
	*/
	private @DataFailureCause int mFailCause = DataFailCause.NONE;

	/** The APN Setting for this data connection */
	private @Nullable ApnSetting mApnSetting = null;

	/**
	* Set the state of the data connection.
	*
	* @param state The state of the data connection
	* @return The builder
	*/
	public Builder setState(@DataState int state) {
	mState = state;
	return this;
	}

	/**
	* Set the network type associated with this data connection.
	*
	* @param networkType The network type
	* @return The builder
	*/
	public Builder setNetworkType(@NetworkType int networkType) {
	mNetworkType = networkType;
	return this;
	}

	/**
	* Set the link properties of the connection.
	*
	* @param linkProperties Link properties
	* @return The builder
	*/
	public Builder setLinkProperties(@NonNull LinkProperties linkProperties) {
	mLinkProperties = linkProperties;
	return this;
	}

	/**
	* Set the fail cause of the data connection.
	*
	* @param failCause In case a procedure related to this data connection fails, a non-zero
	* error code indicating the cause of the failure.
	* @return The builder
	*/
	public Builder setFailCause(@DataFailureCause int failCause) {
	mFailCause = failCause;
	return this;
	}

	/**
	* Set the APN Setting for this data connection.
	*
	* @param apnSetting APN setting
	* @return This builder
	*/
	public Builder setApnSetting(@NonNull ApnSetting apnSetting) {
	mApnSetting = apnSetting;
	return this;
	}

	/**
	* Build the {@link PreciseDataConnectionState} instance.
	*
	* @return The {@link PreciseDataConnectionState} instance
	*/
	public PreciseDataConnectionState build() {
	return new PreciseDataConnectionState(mState, mNetworkType, mLinkProperties, mFailCause,
	mApnSetting);
	}
	}
	}