This repository was archived by the owner on Feb 26, 2023. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathBackground.java
More file actions
206 lines (202 loc) · 5.11 KB
/
Copy pathBackground.java
File metadata and controls
206 lines (202 loc) · 5.11 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
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/**
* Copyright (C) 2010-2016 eBusiness Information, Excilys Group
* Copyright (C) 2016-2020 the AndroidAnnotations 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 org.androidannotations.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* <p>
* Should be used on method that must be run in a background thread.
* </p>
* <p>
* The annotated method MUST return void and MAY contain parameters.
* </p>
* <p>
* The generated code is based on
* {@link org.androidannotations.api.BackgroundExecutor BackgroundExecutor}
* methods.
* </p>
*
* <h2>Cancellation</h2>
* <p>
* Since 3.0, you're able to cancel a background task by calling
* <code>BackgroundExecutor.cancelAll("id")</code> where "id" matches the
* {@link #id()} value.
*
* </p>
* <blockquote>
*
* <b>Example</b> :
*
* <pre>
* @EBean
* public class MyBean {
* private static final String TASK_ID = "task1";
*
* @Background(id = TASK_ID)
* void launchTask() {
* // ...
* }
*
* void stopTask() {
* BackgroundExecutor.cancelAll(TASK_ID);
* }
*
* }
* </pre>
*
* </blockquote>
* <p>
* <b>Note</b>: Cancellation may or may not be successful. If the task wasn't
* executed yet, it will be removed from the pool. But it could fail if task has
* already completed, has already been cancelled, or could not be cancelled for
* some other reason. See {@link java.util.concurrent.Future#cancel(boolean)
* Future#cancel(boolean)} for more information.
* </p>
*
* <h2>Execution flow</h2>
* <p>
* By default, all tasks will be put in a
* {@link java.util.concurrent.ScheduledThreadPoolExecutor
* ScheduledThreadPoolExecutor} with a core pool size of
* <code>2 * numberOfCpu</code>. Which means that background methods will be
* executed in <b>PARALLEL</b>. You can change this by calling
* <code>BackgroundExecutor.setExecutor(...)</code>.
* </p>
* <p>
* If you want execute ALL background methods SEQUENTIALLY, the best way is to
* change the executor of {@link org.androidannotations.api.BackgroundExecutor
* BackgroundExecutor} to a
* {@link java.util.concurrent.ScheduledThreadPoolExecutor
* ScheduledThreadPoolExecutor} with a core pool size of <code>1</code>.
* </p>
* <p>
* If you want execute some background methods SEQUENTIALLY, you should simply
* use {@link #serial()} field. All task with the same serial key will be
* executed sequentially.
* </p>
*
* <blockquote>
*
* <b>Example 1</b> (all tasks executed sequentially) :
*
* <pre>
* @EBean
* public class MyBean {
*
* static {
* BackgroundExecutor.setExecutor(Executors.newScheduledThreadPool(1));
* }
*
* private int i = 0;
*
* void launchTasks() {
* backgroundTask();
* backgroundTask();
* backgroundTask();
* }
*
* @Background
* void backgroundTask() {
* Log.i("AA", "i = ", i++);
* }
* }
* </pre>
*
* <b>Example 2</b> (some tasks executed sequentially) :
*
* <pre>
* @EBean
* public class MyBean {
*
* private int i = 0;
*
* void launchTasks() {
* backgroundTask();
* backgroundTask();
* backgroundTask();
* }
*
* @Background(serial = "sequence1")
* void backgroundTask() {
* Log.i("AA", "i = ", i++);
* }
* }
* </pre>
*
* </blockquote>
*
*
* <h2>Delay</h2>
* <p>
* Sometimes you may want to delay execution of a background method. To do so,
* you should use the {@link #delay()} field.
* </p>
* <b>Example</b> :
*
* <blockquote>
*
* <pre>
* @EBean
* public class MyBean {
*
* @Background(delay = 2000)
* void backgroundTask() {
* // ...
* }
* }
* </pre>
*
* </blockquote>
*
*
* @see UiThread
* @see org.androidannotations.api.BackgroundExecutor
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface Background {
/**
* Identifier for task cancellation.
*
* To cancel all tasks having a specified background id:
*
* <pre>
* boolean mayInterruptIfRunning = true;
* BackgroundExecutor.cancelAll("my_background_id", mayInterruptIfRunning);
* </pre>
*
* @return the task id for cancellation
**/
String id() default "";
/**
* Minimum delay, in milliseconds, before the background task is executed.
*
* @return the delay of the execution
*/
long delay() default 0;
/**
* Serial execution group.
*
* All background tasks having the same <code>serial</code> will be executed
* sequentially.
*
* @return the serial execution group
**/
String serial() default "";
}