Repository navigation
Expand file tree
/
Copy pathOrmLiteDao.java
More file actions
89 lines (84 loc) · 2.69 KB
/
Copy pathOrmLiteDao.java
File metadata and controls
89 lines (84 loc) · 2.69 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
/**
* 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>
* Use it on fields of any enhanced class to injects an OrmLite Dao, configured
* with the provided mode and helper classes.
* </p>
* <p>
* All parameters are mandatory:
* </p>
* <ul>
* <li><i>helper</i>: should hold the class of your database helper which should
* extend com.j256.ormlite.android.apptools.OrmLiteSqliteOpenHelper</li>
* <li><i>model</i>: should point to the model class that the DAO relates to. It
* should match the type of the first generic parameter of your Dao.</li>
* </ul>
* <p>
* <b>Note:</b> The minimum version required of ORMLite is 4.21
* </p>
* <p>
* <b>Note:</b> For getting and releasing the helper, we use the <a href=
* "http://ormlite.com/javadoc/ormlite-android/com/j256/ormlite/android/apptools/OpenHelperManager.html"
* >OpenHelperManager</a> class, which cannot handle two different helpers at
* the same time. So if you are using multiple database helpers, be careful with
* {@link OrmLiteDao} annotations.
* </p>
* <blockquote>
*
* Example :
*
* <pre>
* @EActivity
* public class MyActivity extends Activity {
*
* // UserDao is a Dao<User, Long>
* @OrmLiteDao(helper = DatabaseHelper.class, model = User.class)
* UserDao userDao;
*
* @OrmLiteDao(helper = DatabaseHelper.class, model = Car.class)
* Dao<Car, Long> carDao;
* }
* </pre>
*
* </blockquote>
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.FIELD)
public @interface OrmLiteDao {
/**
* The class of the used database helper.
*
* @return the helper class
*/
Class<?> helper();
/**
* The class of the model what this DAO can manage.
*
* @deprecated Since <b>3.1</b> the model class is inferred from the type of
* the annotated field. This parameter will be removed in a
* future version.
*
* @return the model class
*/
@Deprecated
Class<?> model() default Void.class;
}