/**
* Copyright (C) 2010-2016 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.ormlite.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>
* The helper paramter is mandatory and should hold the class of your database
* helper which should extend
* com.j256.ormlite.android.apptools.OrmLiteSqliteOpenHelper
* </p>
* <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)
* UserDao userDao;
*
* @OrmLiteDao(helper = DatabaseHelper.class)
* Dao<Car, Long> carDao;
*
* @OrmLiteDao(helper = DatabaseHelper.class)
* void singleInjection2(UserDao userDao) {
* // do stuff
* }
*
* void multiInjection(@OrmLiteDao(helper = DatabaseHelper.class) UserDao userDao, @OrmLiteDao(helper = DatabaseHelper.class) Dao<Car, Long> carDao;) {
* // do stuff
* }
* }
* </pre>
*
* </blockquote>
*/
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })
public @interface OrmLiteDao {
/**
* The class of the used database helper.
*
* @return the helper class
*/
Class<?> helper();
}