content: /**
   * 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.sharedpreferences;
  
  import java.lang.annotation.ElementType;
  import java.lang.annotation.Retention;
  import java.lang.annotation.RetentionPolicy;
  import java.lang.annotation.Target;
  
  import android.content.Context;
  
  /**
   * <p>
   * Apply @{@link SharedPref} on an interface to create a SharedPreference helper
   * that will contain access methods related to the methods you define in the
   * interface.
   * </p>
   * <p>
   * You should then inject your SharedPreference generated class by using
   * {@link Pref} annotation.
   * </p>
   * <blockquote>
   * 
   * Example :
   * 
   * <pre>
   * &#064;EBean
   * public class MyBean {
   * 
   * 	&#064;Pref
   * 	<b>mypackage.MyPref_</b> myPref;
   * }
   * 
   * 
   * package <b>mypackage</b>;
   * 
   * &#064;SharedPref
   * public interface <b>MyPref</b> {
   * 
   * 	// The field name will have default value "John"
   * 	&#064;DefaultString("John")
   * 	String name();
   * 
   * 	// The field age will have default value 42
   * 	&#064;DefaultInt(42)
   * 	int age();
   * 
   * 	// The field lastUpdated will have default value 0
   * 	long lastUpdated();
   * }
   * </pre>
   * 
   * </blockquote>
   * 
   * @see Pref
   */
  @Retention(RetentionPolicy.CLASS)
  @Target(ElementType.TYPE)
  public @interface SharedPref {
  
  	/**
  	 * Represents the scope of a SharedPreference.
  	 */
  	enum Scope {
  		/**
  		 * The default shared SharedPreference.
  		 */
  		APPLICATION_DEFAULT, //
  		/**
  		 * The name of the SharedPreference will contain the name of the Activity and
  		 * the name annotated interface.
  		 */
  		ACTIVITY, //
  
  		/**
  		 * The name of the SharedPreference will contain the name of the Activity (also
  		 * available through activity.getPreferences()).
  		 */
  		ACTIVITY_DEFAULT, //
  
  		/**
  		 * The name of the SharedPreference will be the name of the annotated interface.
  		 */
  		UNIQUE
  	}
  
  	/**
  	 * The scope of the preferences, this will change the name of the
  	 * SharedPreference.
  	 * 
  	 * @return the scope of the preferences
  	 */
  	Scope value() default Scope.ACTIVITY;
  
  	/**
  	 * The name of the preferences. To be used with {@link Scope#ACTIVITY} or
  	 * {@link Scope#UNIQUE}. If empty the interface name is used.
  	 *
  	 * @return the name of the preferences
  	 */
  	String name() default "";
  
  	/**
  	 * The operating mode.
  	 * 
  	 * @see Context#MODE_PRIVATE
  	 * @see Context#MODE_WORLD_READABLE
  	 * @see Context#MODE_WORLD_WRITEABLE
  	 * 
  	 * @return the operating mode
  	 */
  	int mode() default Context.MODE_PRIVATE;
  }
  