Repository navigation
Expand file tree
/
Copy pathReceiver.java
More file actions
100 lines (93 loc) · 3.28 KB
/
Copy pathReceiver.java
File metadata and controls
100 lines (93 loc) · 3.28 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
/**
* Copyright (C) 2010-2014 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>
* This annotation is intended to be used on methods of an {@link EActivity},
* {@link EFragment} or {@link EService}. When this annotation is used, a
* {@link android.content.BroadcastReceiver} will be created to receive the
* Intent corresponding to the given actions and it will call the annotated
* method.
* </p>
* <p>
* The annotated method MUST return void and MAY have one parameter:
* </p>
* <ul>
* <li>An {@link android.content.Intent}</li>
* </ul>
* <p>
* The annotation has four parameters:
* </p>
* <ul>
* <li>
* {@link #actions()}: One or several {@link java.lang.String} indicating the
* actions which will spark the method. This parameter is MANDATORY</li>
* <li>
* {@link #dataSchemes()}: One or several {@link java.lang.String} indicating
* the data schemes which should be handled.</li>
* <li>
* {@link #registerAt()}: The moment when the
* {@link android.content.BroadcastReceiver} will be registered and
* unregistered. By default : OnCreate/OnDestroy. The available values depend on
* the enclosing enhanced component.</li>
* <li>
* {@link #local()}: Specify whether
* android.support.v4.content.LocalBroadcastManager should be used. To use
* android.support.v4.content.LocalBroadcastManager, you MUST have android
* support-v4 in your classpath. Default value is false.</li>
* </ul>
*
* <blockquote>
*
* Example :
*
* <pre>
* @EActivity
* public class MyActivity {
*
* @Receiver(actions = {@link android.net.wifi.WifiManager#WIFI_STATE_CHANGED_ACTION})
* public void onWifiStateChanged(Intent intent);
*
* @Receiver(actions = {@link android.net.wifi.WifiManager#WIFI_STATE_CHANGED_ACTION}, registerAt = RegisterAt.OnResumeOnPause)
* public void onWifiStateChangedWithoutIntent();
*
* @Receiver(actions = {@link android.content.Intent#ACTION_VIEW}, dataSchemes = "http")
* public void onHttpUrlOpened(Intent intent);
*
* @Receiver(actions = {@link android.content.Intent#ACTION_VIEW}, dataSchemes = {"http", "https"})
* public void onHttpOrHttpsUrlOpened(Intent intent);
*
* }
* </pre>
*
* </blockquote>
*
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface Receiver {
String[] actions();
String[] dataSchemes() default {};
RegisterAt registerAt() default RegisterAt.OnCreateOnDestroy;
boolean local() default false;
public enum RegisterAt {
OnCreateOnDestroy, OnStartOnStop, OnResumeOnPause, OnAttachOnDetach
}
}