org.androidannotations.annotations.sharedpreferences.Pref Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of androidannotations-api Show documentation

The API jar containing the annotations and the runtime helpers

There is a newer version: 4.8.0

Show 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.annotations.sharedpreferences;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 
 * Injects an {@link SharedPref} annotated class in any enhanced class.
 * 
 * 
 * The field or method parameter MUST be of a type that is generated using {@link SharedPref} and
 * therefore extends
 * {@link org.androidannotations.api.sharedpreferences.SharedPreferencesHelper
 * SharedPreferencesHelper}.
 * 
 * 
 * Note: To prevent you from any building issues, you should use fully
 * qualified name for the field type.
 * 
 * 
 * 
 * Example :
 * 
 *  * @EBean
 * public class MyBean {
 * 
 * 	@Pref
 * 	mypackage.MyPref_ myPref;
 * 
 * 	@Pref
 * 	void methodInjection(mypackage.MyPref_ myPref) {
 * 		// do stuff	
 * 	}	
 * }
 * 
 * 
 * package mypackage;
 * 
 * @SharedPref
 * public interface MyPref {
 * 
 * }
 * 
 * 
 * 
 * 
 * @see SharedPref
 */
@Retention(RetentionPolicy.CLASS)
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })
public @interface Pref {
}