Repository navigation
Expand file tree
/
Copy pathWakeLock.java
More file actions
131 lines (118 loc) · 3.12 KB
/
Copy pathWakeLock.java
File metadata and controls
131 lines (118 loc) · 3.12 KB
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
/**
* Copyright (C) 2010-2015 eBusiness Information, Excilys Group
*
* 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 org.androidannotations.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* <p>
* Acquires a {@link android.os.PowerManager.WakeLock} for this method call.
* </p>
* <p>
* May be used on methods with @Background or @UiThread.
* </p>
* <p>
* <b>NOTE</b>: To use WakeLocks you need the
* <i>android.permission.WAKE_LOCK</i> permission.
* </p>
*
* <b>Example</b>:
*
* <pre>
* @EActivity
* public class MyActivity extends Acitivy {
*
* @WakeLock
* void backgroundTask() {
* // this code executes with an active WakeLock.
* }
* }
* </pre>
*
* @see android.os.PowerManager
* @see android.os.PowerManager.WakeLock
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface WakeLock {
/**
* Indicates the client did not give a tag.
*/
String DEFAULT_TAG = "NO_TAG";
/**
* The tag of the created WakeLock.
*
* @see android.os.PowerManager#newWakeLock(int, String)
*
* @return the tag of the WakeLock
*/
String tag() default DEFAULT_TAG;
/**
* The level of the created {@link android.os.PowerManager.WakeLock
* WakeLock}.
*
* @see android.os.PowerManager#newWakeLock(int, String)
*
* @return the level of the WakeLock
*/
Level level() default Level.PARTIAL_WAKE_LOCK;
/**
* The optional flags for the created
* {@link android.os.PowerManager.WakeLock WakeLock}.
*
* @see android.os.PowerManager#newWakeLock(int, String)
*
* @return the flags of the WakeLock
*/
Flag[] flags() default {};
/**
* A convenience wrapper enum for the
* {@link android.os.PowerManager.WakeLock WakeLock} level integer values.
*/
public enum Level {
/**
* Represents {@link android.os.PowerManager#FULL_WAKE_LOCK}.
*/
FULL_WAKE_LOCK,
/**
* Represents {@link android.os.PowerManager#PARTIAL_WAKE_LOCK}.
*/
PARTIAL_WAKE_LOCK,
/**
* Represents {@link android.os.PowerManager#SCREEN_BRIGHT_WAKE_LOCK}.
*/
SCREEN_BRIGHT_WAKE_LOCK,
/**
* Represents {@link android.os.PowerManager#SCREEN_DIM_WAKE_LOCK}.
*/
SCREEN_DIM_WAKE_LOCK;
}
/**
* A convenience wrapper enum for the
* {@link android.os.PowerManager.WakeLock WakeLock} flag integer values.
*/
public enum Flag {
/**
* Represents {@link android.os.PowerManager#ACQUIRE_CAUSES_WAKEUP}.
*/
ACQUIRE_CAUSES_WAKEUP,
/**
* Represents {@link android.os.PowerManager#ON_AFTER_RELEASE}.
*/
ON_AFTER_RELEASE
}
}