This repository was archived by the owner on Feb 26, 2023. It is now read-only.
Repository navigation
Expand file tree
/
Copy pathEBean.java
More file actions
143 lines (133 loc) · 4.02 KB
/
Copy pathEBean.java
File metadata and controls
143 lines (133 loc) · 4.02 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
/**
* 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;
import org.androidannotations.api.KotlinOpen;
/**
* <p>
* Should be used on custom classes to enable usage of AndroidAnnotations.
* </p>
* <p>
* This class MUST have either a default constructor (ie without parameters) or
* a constructor with only a parameter of type {@link android.content.Context}.
* </p>
* <p>
* Your code related to injected beans should go in an {@link AfterInject}
* annotated method.
* </p>
* <p>
* If the class is abstract, the enhanced bean will not be generated. Otherwise,
* it will be generated as a final class. You can use AndroidAnnotations to
* create Abstract classes that handle common code.
* </p>
* <p>
* {@link EBean} can only be used on classes and NOT on interfaces. If you want
* to use an {@link EBean} with interface you must annotate the implementation
* class and not the interface.
* </p>
* <p>
* Most annotations are supported in {@link EBean} classes, except the ones
* related to extras. Views related annotations will only work if the bean was
* injected in an activity with a layout containing the views you're dealing
* with. If your bean needs a {@link android.content.Context} you can inject on
* by using an {@link RootContext} annotated field.
* </p>
* <p>
* Beans have two possible scopes : default or singleton. Default scope should
* be preferred but in some case it may be useful to use a singleton scope
* (mainly if you want to keep some runtime state in your bean).
* </p>
* <p>
* The enhanced bean can also be injected in any enhanced class by using
* {@link Bean} annotation.
* </p>
* <blockquote>
*
* Example :
*
* <pre>
* @EBean
* public class MyBean {
*
* @RootContext
* Context context;
* @Bean
* MySingletonBean mySingletonBean;
*
* @AfterInject
* void init() {
* mySingletonBean.doSomeStuff(context);
* }
* }
*
* @EBean(scope = Scope.Singleton)
* public class MySingletonBean {
*
* public void doSomeStuff(Context context) {
* // ...
* }
* }
* </pre>
*
* </blockquote>
*
* @see AfterInject
* @see RootContext
* @see Bean
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
@KotlinOpen
public @interface EBean {
/**
* The scope of an enhanced bean.
*/
enum Scope {
/**
* A new instance of the bean is created each time it is needed.
*/
Default, //
/**
* A new instance of the bean is created the first time it is needed in an
* Activity scope, it is then retained and the same instance is always returned
* from within the same Activity. Different Activities hold different copies of
* the bean.
*/
Activity,
/**
* A new instance of the bean is created the first time it is needed in a
* Fragment scope, it is then retained and the same instance is always returned
* from within the same Fragment. Different Fragments hold different copies of
* the bean.
*/
Fragment,
/**
* A new instance of the bean is created the first time it is needed, it is then
* retained and the same instance is always returned.
*/
Singleton, //
}
/**
* The scope of the enhanced bean.
*
* @return the scope of the bean.
*/
Scope scope() default Scope.Default;
}