Repository navigation
Expand file tree
/
Copy pathReceiverAction.java
More file actions
104 lines (98 loc) · 3.29 KB
/
Copy pathReceiverAction.java
File metadata and controls
104 lines (98 loc) · 3.29 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
/**
* 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>
* Should be used on a method that must respond to a specific action in an
* {@link EReceiver} annotated class. The method name will be used as action
* name unless the {@link #value()} field is set.
* </p>
* <p>
* The class MAY contain several {@link ReceiverAction} annotated methods.
* </p>
* <p>
* The method annotated with {@link ReceiverAction} may have as parameters :
* - A {@link android.content.Context} which will be the context given in {@code void onReceive(Context context, Intent intent)}
* - A {@link android.content.Intent} which will be the intent given in {@code void onReceive(Context context, Intent intent)}
* - Some any native, {@link android.os.Parcelable} or {@link java.io.Serializable} parameters
* annotated with {@link ReceiverAction.Extra} which will be the extra put in the intent. The key of this extra is
* the value of the annotation {@link ReceiverAction.Extra} if set or the name of the parameter.
* </p>
*
* <blockquote>
*
* Example :
*
* <pre>
* @EReceiver
* public class MyIntentService extends BroadcastReceiver {
*
* @ReceiverAction
* void mySimpleAction(Intent intent) {
* // ...
* }
*
* @ReceiverAction
* void myAction(@ReceiverAction.Extra String valueString, Context context) {
* // ...
* }
*
* @ReceiverAction
* void anotherAction(@ReceiverAction.Extra("specialExtraName") String valueString, @ReceiverAction.Extra long valueLong) {
* // ...
* }
* }
* </pre>
*
* </blockquote>
*
* @see EReceiver
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface ReceiverAction {
/**
* Define the action's name. If this field isn't set the annotated method
* name will be used.
*
* @return the action's name
*/
String value() default "";
/**
* <p>
* Should be used on any native, {@link android.os.Parcelable} or {@link java.io.Serializable} parameter of a method
* annotated with {@link ReceiverAction} to inject the extra put in the intent parameter
* of {@code void onReceive(Context context, Intent intent)}.
* The key of this extra is the value of the annotation {@link ReceiverAction.Extra} if it is set
* or the name of the parameter.
* </p>
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.PARAMETER)
public @interface Extra {
/**
* Define the extra's name. If this parameter isn't set the annotated
* parameter name will be used.
*
* @return the extra's name
*/
String value() default "";
}
}