1 /*
2  * Copyright (c) 2014, The Linux Foundation. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *    * Redistributions of source code must retain the above copyright
8         notice, this list of conditions and the following disclaimer.
9  *    * Redistributions in binary form must reproduce the above
10  *      copyright notice, this list of conditions and the following
11  *      disclaimer in the documentation and/or other materials provided
12  *      with the distribution.
13  *    * Neither the name of The Linux Foundation nor the names of its
14  *      contributors may be used to endorse or promote products derived
15  *      from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
18  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
21  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
24  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
26  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 package com.android.ims;
31 
32 import java.util.concurrent.Executor;
33 
34 /**
35  * Listener for receiving notifications about changes to the IMS connection.
36  * It provides a state of IMS registration between UE and IMS network, the service
37  * availability of the local device during IMS registered.
38  *
39  * @hide
40  */
41 public abstract class ImsEcbmStateListener {
42     protected Executor mListenerExecutor = Runnable::run;
43     /**
44      * constructor.
45      *
46      * @param executor the executor that will execute callbacks.
47      */
ImsEcbmStateListener(Executor executor)48     public ImsEcbmStateListener(Executor executor) {
49         if (executor != null)
50             mListenerExecutor = executor;
51     }
52     /**
53      * Called when the device enters Emergency Callback Mode
54      */
onECBMEntered()55     public final void onECBMEntered() {
56         onECBMEntered(mListenerExecutor);
57     }
58 
59     /**
60      * Called when the device enters Emergency Callback Mode
61      *
62      * @param executor the executor that will execute callbacks.
63      */
onECBMEntered(Executor executor)64     public abstract void onECBMEntered(Executor executor);
65 
66     /**
67      * Called when the device exits Emergency Callback Mode
68      */
onECBMExited()69     public final void onECBMExited() {
70         onECBMExited(mListenerExecutor);
71     }
72 
73     /**
74      * Called when the device exits Emergency Callback Mode
75      *
76      * @param executor the executor that will execute callbacks.
77      */
onECBMExited(Executor executor)78     public abstract void onECBMExited(Executor executor);
79 }
80