1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
/*
* Copyright (C) 2010 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 com.android.systemui.statusbar.policy;
import android.annotation.Nullable;
import android.view.View;
import com.android.systemui.demomode.DemoMode;
import com.android.systemui.statusbar.policy.BatteryController.BatteryStateChangeCallback;
import java.io.PrintWriter;
import java.lang.ref.WeakReference;
/**
* Controller for battery related information, including the charge level, power save mode,
* and time remaining information
*/
public interface BatteryController extends DemoMode,
CallbackController<BatteryStateChangeCallback> {
/**
* Prints the current state of the {@link BatteryController} to the given {@link PrintWriter}.
*/
void dump(PrintWriter pw, String[] args);
/**
* Sets if the current device is in power save mode.
*/
default void setPowerSaveMode(boolean powerSave) {
setPowerSaveMode(powerSave, null);
}
/**
* Sets if the current device is in power save mode.
*
* Can pass the view that triggered the request.
*/
void setPowerSaveMode(boolean powerSave, @Nullable View view);
/**
* Gets a reference to the last view used when called {@link #setPowerSaveMode}.
*/
@Nullable
default WeakReference<View> getLastPowerSaverStartView() {
return null;
}
/**
* Clears the last view used when called {@link #setPowerSaveMode}.
*
* Immediately after calling this, a call to {@link #getLastPowerSaverStartView()} should return
* {@code null}.
*/
default void clearLastPowerSaverStartView() {}
/**
* Returns {@code true} if the device is currently plugged in.
*/
boolean isPluggedIn();
/**
* Returns {@code true} if the device is currently plugged in via wireless charger.
*/
default boolean isPluggedInWireless() {
return false;
}
/**
* Returns {@code true} if the device is currently in power save mode.
*/
boolean isPowerSave();
/**
* Returns {@code true} if AOD was disabled by power saving policies.
*/
boolean isAodPowerSave();
/**
* Initializes the class.
*/
default void init() { }
/**
* Returns {@code true} if the device is currently in wireless charging mode.
*/
default boolean isWirelessCharging() { return false; }
/**
* Returns {@code true} if reverse is supported.
*/
default boolean isReverseSupported() { return false; }
/**
* Returns {@code true} if reverse is on.
*/
default boolean isReverseOn() { return false; }
/**
* Set reverse state.
* @param isReverse true if turn on reverse, false otherwise
*/
default void setReverseState(boolean isReverse) {}
/**
* Returns {@code true} if extreme battery saver is on.
*/
default boolean isExtremeSaverOn() {
return false;
}
/**
* Returns {@code true} if the charging source is
* {@link android.os.BatteryManager#BATTERY_PLUGGED_DOCK}.
*
* <P>Note that charging from dock is not considered as wireless charging. In other words,
* {@link BatteryController#isWirelessCharging()} and this are mutually exclusive.
*/
default boolean isChargingSourceDock() {
return false;
}
/**
* A listener that will be notified whenever a change in battery level or power save mode has
* occurred.
*/
interface BatteryStateChangeCallback {
default void onBatteryLevelChanged(int level, boolean pluggedIn, boolean charging) {
}
default void onPowerSaveChanged(boolean isPowerSave) {
}
default void onBatteryUnknownStateChanged(boolean isUnknown) {
}
default void onReverseChanged(boolean isReverse, int level, String name) {
}
default void onExtremeBatterySaverChanged(boolean isExtreme) {
}
default void onWirelessChargingChanged(boolean isWirlessCharging) {
}
default void onIsOverheatedChanged(boolean isOverheated) {
}
}
/**
* If available, get the estimated battery time remaining as a string.
*
* @param completion A lambda that will be called with the result of fetching the estimate. The
* first time this method is called may need to be dispatched to a background thread. The
* completion is called on the main thread
*/
default void getEstimatedTimeRemainingString(EstimateFetchCompletion completion) {}
/**
* Callback called when the estimated time remaining text is fetched.
*/
public interface EstimateFetchCompletion {
/**
* The callback
* @param estimate the estimate
*/
void onBatteryRemainingEstimateRetrieved(@Nullable String estimate);
}
}
|
