org.androidannotations.ormlite.annotations.OrmLiteDao Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ormlite-api Show documentation
The API jar containing the annotations
The newest version!
/**
 * 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;

/**
 * 
 * Use it on fields of any enhanced class to injects an OrmLite Dao, configured
 * with the provided mode and helper classes.
 * 
 * 
 * The helper paramter is mandatory and should hold the class of your database
 * helper which should extend
 * com.j256.ormlite.android.apptools.OrmLiteSqliteOpenHelper
 * 
 * 
 * Note: The minimum version required of ORMLite is 4.21
 * 
 * 
 * Note: For getting and releasing the helper, we use the OpenHelperManager 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.
 * 
 * 
 * 
 * Example :
 * 
 *  * @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
 * 	}
 * }
 * 
 * 
 * 
 */
@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();
}