/**
* 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;
import org.androidannotations.annotations.ResId;
/**
* <p>
* Use on methods in {@link SharedPref} annotated class to specified the default
* value of this preference.
* </p>
* <p>
* The annotation value must be one of R.* fields. If the value is not set, the
* method name will be used as the R.* field name.
* </p>
* <table summary="Mapping of return types to thier resource types">
* <tr>
* <th>Return Type</th>
* <th>Resource Type</th>
* </tr>
* <tr>
* <td>String</td>
* <td>R.string.*</td>
* </tr>
* <tr>
* <td>int</td>
* <td>R.integer.*</td>
* </tr>
* <tr>
* <td>long</td>
* <td>R.integer.*</td>
* </tr>
* <tr>
* <td>float</td>
* <td>R.integer.*</td>
* </tr>
* <tr>
* <td>boolean</td>
* <td>R.bool.*</td>
* </tr>
* <tr>
* <td>Set<String></td>
* <td>R.array.*</td>
* </tr>
* </table>
* <p>
* The key of the preference will be the method name by default. This can be
* overridden by specifying a string resource with the {@link #keyRes()}
* parameter.
* </p>
*/
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface DefaultRes {
/**
* The R.id.* field which refers the the resource which is used as the
* default value of the preference.
*
* @return the default value
*/
int value() default ResId.DEFAULT_VALUE;
/**
* The resource name which refers the the resource which is used as the
* default value of the preference.
*
* @return the resource name of the default value
*/
String resName() default "";
/**
* The R.string.* field which refers to the key of the preference.
*
* @return the resource name of the preference key
*/
int keyRes() default ResId.DEFAULT_VALUE;
}