diff options
author | Tor Norbye <tnorbye@google.com> | 2013-05-30 16:48:33 -0700 |
---|---|---|
committer | Tor Norbye <tnorbye@google.com> | 2015-02-18 07:49:03 -0800 |
commit | 7b9c912f536925ac6ec43935d6e97506851b33d6 (patch) | |
tree | 8dd71557e2555fde0d506ef77c46dc29184e91c4 /core/java/android/preference | |
parent | 44bc07d8740058398d4009615681120168673dd8 (diff) | |
download | frameworks_base-7b9c912f536925ac6ec43935d6e97506851b33d6.zip frameworks_base-7b9c912f536925ac6ec43935d6e97506851b33d6.tar.gz frameworks_base-7b9c912f536925ac6ec43935d6e97506851b33d6.tar.bz2 |
Add @ResourceInt annotations on APIs
Change-Id: I119cc059c2f8bd98fd585fc84ac2b1b7d5892a08
Diffstat (limited to 'core/java/android/preference')
10 files changed, 50 insertions, 27 deletions
diff --git a/core/java/android/preference/DialogPreference.java b/core/java/android/preference/DialogPreference.java index b65eac7..1b226c1 100644 --- a/core/java/android/preference/DialogPreference.java +++ b/core/java/android/preference/DialogPreference.java @@ -17,6 +17,8 @@ package android.preference; +import android.annotation.DrawableRes; +import android.annotation.StringRes; import android.app.AlertDialog; import android.app.Dialog; import android.content.Context; @@ -168,7 +170,7 @@ public abstract class DialogPreference extends Preference implements * * @param dialogIconRes The icon, as a resource ID. */ - public void setDialogIcon(int dialogIconRes) { + public void setDialogIcon(@DrawableRes int dialogIconRes) { mDialogIcon = getContext().getDrawable(dialogIconRes); } @@ -194,7 +196,7 @@ public abstract class DialogPreference extends Preference implements * @see #setPositiveButtonText(CharSequence) * @param positiveButtonTextResId The positive button text as a resource. */ - public void setPositiveButtonText(int positiveButtonTextResId) { + public void setPositiveButtonText(@StringRes int positiveButtonTextResId) { setPositiveButtonText(getContext().getString(positiveButtonTextResId)); } @@ -222,7 +224,7 @@ public abstract class DialogPreference extends Preference implements * @see #setNegativeButtonText(CharSequence) * @param negativeButtonTextResId The negative button text as a resource. */ - public void setNegativeButtonText(int negativeButtonTextResId) { + public void setNegativeButtonText(@StringRes int negativeButtonTextResId) { setNegativeButtonText(getContext().getString(negativeButtonTextResId)); } diff --git a/core/java/android/preference/GenericInflater.java b/core/java/android/preference/GenericInflater.java index 7de7d1c..c84dbf1 100644 --- a/core/java/android/preference/GenericInflater.java +++ b/core/java/android/preference/GenericInflater.java @@ -23,6 +23,8 @@ import java.util.HashMap; import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; +import android.annotation.AnyRes; +import android.annotation.XmlRes; import android.content.Context; import android.content.res.XmlResourceParser; import android.util.AttributeSet; @@ -216,7 +218,7 @@ abstract class GenericInflater<T, P extends GenericInflater.Parent> { * this is the root item; otherwise it is the root of the inflated * XML file. */ - public T inflate(int resource, P root) { + public T inflate(@XmlRes int resource, P root) { return inflate(resource, root, root != null); } @@ -256,7 +258,7 @@ abstract class GenericInflater<T, P extends GenericInflater.Parent> { * attachToRoot is true, this is root; otherwise it is the root of * the inflated XML file. */ - public T inflate(int resource, P root, boolean attachToRoot) { + public T inflate(@XmlRes int resource, P root, boolean attachToRoot) { if (DEBUG) System.out.println("INFLATING from resource: " + resource); XmlResourceParser parser = getContext().getResources().getXml(resource); try { diff --git a/core/java/android/preference/ListPreference.java b/core/java/android/preference/ListPreference.java index 9482a72..2700373 100644 --- a/core/java/android/preference/ListPreference.java +++ b/core/java/android/preference/ListPreference.java @@ -16,6 +16,7 @@ package android.preference; +import android.annotation.ArrayRes; import android.app.AlertDialog.Builder; import android.content.Context; import android.content.DialogInterface; @@ -91,7 +92,7 @@ public class ListPreference extends DialogPreference { * @see #setEntries(CharSequence[]) * @param entriesResId The entries array as a resource. */ - public void setEntries(int entriesResId) { + public void setEntries(@ArrayRes int entriesResId) { setEntries(getContext().getResources().getTextArray(entriesResId)); } @@ -119,7 +120,7 @@ public class ListPreference extends DialogPreference { * @see #setEntryValues(CharSequence[]) * @param entryValuesResId The entry values array as a resource. */ - public void setEntryValues(int entryValuesResId) { + public void setEntryValues(@ArrayRes int entryValuesResId) { setEntryValues(getContext().getResources().getTextArray(entryValuesResId)); } diff --git a/core/java/android/preference/MultiCheckPreference.java b/core/java/android/preference/MultiCheckPreference.java index 57c906d..c1260a4 100644 --- a/core/java/android/preference/MultiCheckPreference.java +++ b/core/java/android/preference/MultiCheckPreference.java @@ -18,6 +18,7 @@ package android.preference; import java.util.Arrays; +import android.annotation.ArrayRes; import android.app.AlertDialog.Builder; import android.content.Context; import android.content.DialogInterface; @@ -96,7 +97,7 @@ public class MultiCheckPreference extends DialogPreference { * @see #setEntries(CharSequence[]) * @param entriesResId The entries array as a resource. */ - public void setEntries(int entriesResId) { + public void setEntries(@ArrayRes int entriesResId) { setEntries(getContext().getResources().getTextArray(entriesResId)); } @@ -126,7 +127,7 @@ public class MultiCheckPreference extends DialogPreference { * @see #setEntryValues(CharSequence[]) * @param entryValuesResId The entry values array as a resource. */ - public void setEntryValues(int entryValuesResId) { + public void setEntryValues(@ArrayRes int entryValuesResId) { setEntryValuesCS(getContext().getResources().getTextArray(entryValuesResId)); } diff --git a/core/java/android/preference/MultiSelectListPreference.java b/core/java/android/preference/MultiSelectListPreference.java index 6c4c20f..138bd87 100644 --- a/core/java/android/preference/MultiSelectListPreference.java +++ b/core/java/android/preference/MultiSelectListPreference.java @@ -16,6 +16,7 @@ package android.preference; +import android.annotation.ArrayRes; import android.app.AlertDialog.Builder; import android.content.Context; import android.content.DialogInterface; @@ -87,7 +88,7 @@ public class MultiSelectListPreference extends DialogPreference { * @see #setEntries(CharSequence[]) * @param entriesResId The entries array as a resource. */ - public void setEntries(int entriesResId) { + public void setEntries(@ArrayRes int entriesResId) { setEntries(getContext().getResources().getTextArray(entriesResId)); } @@ -115,7 +116,7 @@ public class MultiSelectListPreference extends DialogPreference { * @see #setEntryValues(CharSequence[]) * @param entryValuesResId The entry values array as a resource. */ - public void setEntryValues(int entryValuesResId) { + public void setEntryValues(@ArrayRes int entryValuesResId) { setEntryValues(getContext().getResources().getTextArray(entryValuesResId)); } diff --git a/core/java/android/preference/Preference.java b/core/java/android/preference/Preference.java index 0224c73..78928b2 100644 --- a/core/java/android/preference/Preference.java +++ b/core/java/android/preference/Preference.java @@ -18,6 +18,9 @@ package android.preference; import com.android.internal.util.CharSequences; +import android.annotation.DrawableRes; +import android.annotation.LayoutRes; +import android.annotation.StringRes; import android.content.Context; import android.content.Intent; import android.content.SharedPreferences; @@ -424,7 +427,7 @@ public class Preference implements Comparable<Preference> { * a {@link View}. * @see #setWidgetLayoutResource(int) */ - public void setLayoutResource(int layoutResId) { + public void setLayoutResource(@LayoutRes int layoutResId) { if (layoutResId != mLayoutResId) { // Layout changed mCanRecycleLayout = false; @@ -438,6 +441,7 @@ public class Preference implements Comparable<Preference> { * * @return The layout resource ID. */ + @LayoutRes public int getLayoutResource() { return mLayoutResId; } @@ -452,7 +456,7 @@ public class Preference implements Comparable<Preference> { * main layout. * @see #setLayoutResource(int) */ - public void setWidgetLayoutResource(int widgetLayoutResId) { + public void setWidgetLayoutResource(@LayoutRes int widgetLayoutResId) { if (widgetLayoutResId != mWidgetLayoutResId) { // Layout changed mCanRecycleLayout = false; @@ -465,6 +469,7 @@ public class Preference implements Comparable<Preference> { * * @return The layout resource ID. */ + @LayoutRes public int getWidgetLayoutResource() { return mWidgetLayoutResId; } @@ -648,7 +653,7 @@ public class Preference implements Comparable<Preference> { * @see #setTitle(CharSequence) * @param titleResId The title as a resource ID. */ - public void setTitle(int titleResId) { + public void setTitle(@StringRes int titleResId) { setTitle(mContext.getString(titleResId)); mTitleRes = titleResId; } @@ -660,6 +665,7 @@ public class Preference implements Comparable<Preference> { * @return The title resource. * @see #setTitle(int) */ + @StringRes public int getTitleRes() { return mTitleRes; } @@ -696,7 +702,7 @@ public class Preference implements Comparable<Preference> { * @see #setIcon(Drawable) * @param iconResId The icon as a resource ID. */ - public void setIcon(int iconResId) { + public void setIcon(@DrawableRes int iconResId) { mIconResId = iconResId; setIcon(mContext.getDrawable(iconResId)); } @@ -739,7 +745,7 @@ public class Preference implements Comparable<Preference> { * @see #setSummary(CharSequence) * @param summaryResId The summary as a resource. */ - public void setSummary(int summaryResId) { + public void setSummary(@StringRes int summaryResId) { setSummary(mContext.getString(summaryResId)); } diff --git a/core/java/android/preference/PreferenceActivity.java b/core/java/android/preference/PreferenceActivity.java index 04cd7d5..0d80c0d 100644 --- a/core/java/android/preference/PreferenceActivity.java +++ b/core/java/android/preference/PreferenceActivity.java @@ -16,6 +16,8 @@ package android.preference; +import android.annotation.StringRes; +import android.annotation.XmlRes; import android.app.Fragment; import android.app.FragmentBreadCrumbs; import android.app.FragmentManager; @@ -337,6 +339,7 @@ public abstract class PreferenceActivity extends ListActivity implements * Resource ID of title of the header that is shown to the user. * @attr ref android.R.styleable#PreferenceHeader_title */ + @StringRes public int titleRes; /** @@ -349,6 +352,7 @@ public abstract class PreferenceActivity extends ListActivity implements * Resource ID of optional summary describing what this header controls. * @attr ref android.R.styleable#PreferenceHeader_summary */ + @StringRes public int summaryRes; /** @@ -361,6 +365,7 @@ public abstract class PreferenceActivity extends ListActivity implements * Resource ID of optional text to show as the title in the bread crumb. * @attr ref android.R.styleable#PreferenceHeader_breadCrumbTitle */ + @StringRes public int breadCrumbTitleRes; /** @@ -373,6 +378,7 @@ public abstract class PreferenceActivity extends ListActivity implements * Resource ID of optional text to show as the short title in the bread crumb. * @attr ref android.R.styleable#PreferenceHeader_breadCrumbShortTitle */ + @StringRes public int breadCrumbShortTitleRes; /** @@ -797,7 +803,7 @@ public abstract class PreferenceActivity extends ListActivity implements * @param resid The XML resource to load and parse. * @param target The list in which the parsed headers should be placed. */ - public void loadHeadersFromResource(int resid, List<Header> target) { + public void loadHeadersFromResource(@XmlRes int resid, List<Header> target) { XmlResourceParser parser = null; try { parser = getResources().getXml(resid); @@ -1086,7 +1092,7 @@ public abstract class PreferenceActivity extends ListActivity implements * fragment. */ public Intent onBuildStartFragmentIntent(String fragmentName, Bundle args, - int titleRes, int shortTitleRes) { + @StringRes int titleRes, int shortTitleRes) { Intent intent = new Intent(Intent.ACTION_MAIN); intent.setClass(this, getClass()); intent.putExtra(EXTRA_SHOW_FRAGMENT, fragmentName); @@ -1124,7 +1130,8 @@ public abstract class PreferenceActivity extends ListActivity implements * this set of preferences. */ public void startWithFragment(String fragmentName, Bundle args, - Fragment resultTo, int resultRequestCode, int titleRes, int shortTitleRes) { + Fragment resultTo, int resultRequestCode, @StringRes int titleRes, + @StringRes int shortTitleRes) { Intent intent = onBuildStartFragmentIntent(fragmentName, args, titleRes, shortTitleRes); if (resultTo == null) { startActivity(intent); @@ -1343,9 +1350,9 @@ public abstract class PreferenceActivity extends ListActivity implements * preference panel is done. The launched panel must use * {@link #finishPreferencePanel(Fragment, int, Intent)} when done. * @param resultRequestCode If resultTo is non-null, this is the caller's - * request code to be received with the resut. + * request code to be received with the result. */ - public void startPreferencePanel(String fragmentClass, Bundle args, int titleRes, + public void startPreferencePanel(String fragmentClass, Bundle args, @StringRes int titleRes, CharSequence titleText, Fragment resultTo, int resultRequestCode) { if (mSinglePane) { startWithFragment(fragmentClass, args, resultTo, resultRequestCode, titleRes, 0); diff --git a/core/java/android/preference/PreferenceManager.java b/core/java/android/preference/PreferenceManager.java index 0a0e625..55ee77a 100644 --- a/core/java/android/preference/PreferenceManager.java +++ b/core/java/android/preference/PreferenceManager.java @@ -16,6 +16,7 @@ package android.preference; +import android.annotation.XmlRes; import android.app.Activity; import android.content.Context; import android.content.DialogInterface; @@ -263,7 +264,7 @@ public class PreferenceManager { * root). * @hide */ - public PreferenceScreen inflateFromResource(Context context, int resId, + public PreferenceScreen inflateFromResource(Context context, @XmlRes int resId, PreferenceScreen rootPreferences) { // Block commits setNoCommit(true); @@ -438,7 +439,7 @@ public class PreferenceManager { * and clear it followed by a call to this method with this * parameter set to true. */ - public static void setDefaultValues(Context context, int resId, boolean readAgain) { + public static void setDefaultValues(Context context, @XmlRes int resId, boolean readAgain) { // Use the default shared preferences name and mode setDefaultValues(context, getDefaultSharedPreferencesName(context), diff --git a/core/java/android/preference/SwitchPreference.java b/core/java/android/preference/SwitchPreference.java index 53b5aad..9c3cefc 100644 --- a/core/java/android/preference/SwitchPreference.java +++ b/core/java/android/preference/SwitchPreference.java @@ -16,6 +16,7 @@ package android.preference; +import android.annotation.StringRes; import android.content.Context; import android.content.res.TypedArray; import android.util.AttributeSet; @@ -169,7 +170,7 @@ public class SwitchPreference extends TwoStatePreference { * * @param resId The text as a string resource ID */ - public void setSwitchTextOn(int resId) { + public void setSwitchTextOn(@StringRes int resId) { setSwitchTextOn(getContext().getString(resId)); } @@ -179,7 +180,7 @@ public class SwitchPreference extends TwoStatePreference { * * @param resId The text as a string resource ID */ - public void setSwitchTextOff(int resId) { + public void setSwitchTextOff(@StringRes int resId) { setSwitchTextOff(getContext().getString(resId)); } diff --git a/core/java/android/preference/TwoStatePreference.java b/core/java/android/preference/TwoStatePreference.java index 3823b27..7037aca 100644 --- a/core/java/android/preference/TwoStatePreference.java +++ b/core/java/android/preference/TwoStatePreference.java @@ -16,6 +16,7 @@ package android.preference; +import android.annotation.StringRes; import android.content.Context; import android.content.SharedPreferences; import android.content.res.TypedArray; @@ -116,7 +117,7 @@ public abstract class TwoStatePreference extends Preference { * @see #setSummaryOn(CharSequence) * @param summaryResId The summary as a resource. */ - public void setSummaryOn(int summaryResId) { + public void setSummaryOn(@StringRes int summaryResId) { setSummaryOn(getContext().getString(summaryResId)); } @@ -144,7 +145,7 @@ public abstract class TwoStatePreference extends Preference { * @see #setSummaryOff(CharSequence) * @param summaryResId The summary as a resource. */ - public void setSummaryOff(int summaryResId) { + public void setSummaryOff(@StringRes int summaryResId) { setSummaryOff(getContext().getString(summaryResId)); } |