Most visited

Recently visited

Added in API level 1

SharedPreferences.Editor

public static interface SharedPreferences.Editor

android.content.SharedPreferences.Editor


用于修改SharedPreferences对象中的值的接口。 在编辑器中进行的所有更改都会批处理,并且不会将其复制回原始的SharedPreferences除非您致电commit()apply()

Summary

Public methods

abstract void apply()

将您的首选项更改从此编辑器重新提交到正在编辑的 SharedPreferences对象。

abstract SharedPreferences.Editor clear()

在编辑器中标记以从首选项中删除 所有值。

abstract boolean commit()

将您的首选项更改从此编辑器重新提交到正在编辑的 SharedPreferences对象。

abstract SharedPreferences.Editor putBoolean(String key, boolean value)

在首选项编辑器中设置一个布尔值,一旦 commit()apply()就会被写回。

abstract SharedPreferences.Editor putFloat(String key, float value)

在首选项编辑器中设置一个浮点值,一旦被调用 commit()apply()就会被写回。

abstract SharedPreferences.Editor putInt(String key, int value)

在首选项编辑器中设置一个int值,一旦被调用 commit()apply()就会被写回。

abstract SharedPreferences.Editor putLong(String key, long value)

在首选项编辑器中设置一个长 commit()值,一旦被调用 commit()apply() ,将被写回。

abstract SharedPreferences.Editor putString(String key, String value)

在首选项编辑器中设置一个字符串值,一旦被调用 commit()apply()就会被写回。

abstract SharedPreferences.Editor putStringSet(String key, Set<String> values)

在首选项编辑器中设置一组字符串值,一旦被调用 commit()apply()就会被写回。

abstract SharedPreferences.Editor remove(String key)

在编辑器中标记一个首选项值应该被移除,一旦 commit()被调用,这将在实际首选项中完成。

Public methods

apply

Added in API level 9
void apply ()

将您的首选项更改从此编辑器重新提交到正在编辑的SharedPreferences对象。 这会自动执行请求的修改,替换SharedPreferences中当前的任何修改。

请注意,当两个编辑人员同时修改首选项时,最后一个调用申请获胜。

commit()不同,它将其首选项同步写入持久存储, apply()将其更改提交到内存SharedPreferences ,但开始异步提交到磁盘,并且不会收到任何失败通知。 如果SharedPreferences上的另一位编辑完成SharedPreferences的常规commit()apply()仍然未完成,则commit()将会阻塞,直到完成所有异步提交以及提交本身。

由于 SharedPreferences实例是一个进程中的单身人士,它的安全,以取代任何实例 commit()apply()如果你已经忽略返回值。

你并不需要担心的Android组件的生命周期及其与互动apply()写入磁盘。 该框架确保在切换状态之前完成从apply()磁盘写入。

SharedPreferences.Editor界面不希望直接实现。 但是,如果你以前没有实现,而且现在得到有关缺少错误apply() ,你可以简单地调用commit()apply()

clear

Added in API level 1
SharedPreferences.Editor clear ()

在编辑器中标记以从首选项中删除所有值。 一旦调用提交,唯一剩余的首选项将是您在此编辑器中定义的任何首选项。

请注意,在提交首选项时,无论您在此编辑器上放置方法之前还是之后调用清除,清除都会先完成。

Returns
SharedPreferences.Editor Returns a reference to the same Editor object, so you can chain put calls together.

commit

Added in API level 1
boolean commit ()

将您的首选项更改从此编辑器重新提交到正在编辑的SharedPreferences对象。 这会自动执行请求的修改,替换SharedPreferences中当前的任何修改。

请注意,当两个编辑器同时修改首选项时,最后一个调用commit的成功。

如果您不关心返回值,并且您在应用程序的主线程中使用了此值,请考虑使用 apply()

Returns
boolean Returns true if the new values were successfully written to persistent storage.

putBoolean

Added in API level 1
SharedPreferences.Editor putBoolean (String key, 
                boolean value)

在首选项编辑器中设置一个布尔值,一旦被调用 commit()apply() ,将被写回。

Parameters
key String: The name of the preference to modify.
value boolean: The new value for the preference.
Returns
SharedPreferences.Editor Returns a reference to the same Editor object, so you can chain put calls together.

putFloat

Added in API level 1
SharedPreferences.Editor putFloat (String key, 
                float value)

在首选项编辑器中设置一个浮点值,一旦被调用 commit()apply() ,将被写回。

Parameters
key String: The name of the preference to modify.
value float: The new value for the preference.
Returns
SharedPreferences.Editor Returns a reference to the same Editor object, so you can chain put calls together.

putInt

Added in API level 1
SharedPreferences.Editor putInt (String key, 
                int value)

在首选项编辑器中设置一个int值,一旦 commit()apply()就会被写回。

Parameters
key String: The name of the preference to modify.
value int: The new value for the preference.
Returns
SharedPreferences.Editor Returns a reference to the same Editor object, so you can chain put calls together.

putLong

Added in API level 1
SharedPreferences.Editor putLong (String key, 
                long value)

在首选项编辑器中设置一个长 commit()值,一旦被调用 commit()apply()就会被写回。

Parameters
key String: The name of the preference to modify.
value long: The new value for the preference.
Returns
SharedPreferences.Editor Returns a reference to the same Editor object, so you can chain put calls together.

putString

Added in API level 1
SharedPreferences.Editor putString (String key, 
                String value)

在首选项编辑器中设置一个字符串值,一旦被调用 commit()apply() ,将被写回。

Parameters
key String: The name of the preference to modify.
value String: The new value for the preference. Passing null for this argument is equivalent to calling remove(String) with this key.
Returns
SharedPreferences.Editor Returns a reference to the same Editor object, so you can chain put calls together.

putStringSet

Added in API level 11
SharedPreferences.Editor putStringSet (String key, 
                Set<String> values)

在首选项编辑器中设置一组字符串值,一旦被调用 commit()apply() ,将被写回。

Parameters
key String: The name of the preference to modify.
values Set: The set of new values for the preference. Passing null for this argument is equivalent to calling remove(String) with this key.
Returns
SharedPreferences.Editor Returns a reference to the same Editor object, so you can chain put calls together.

remove

Added in API level 1
SharedPreferences.Editor remove (String key)

在编辑器中标记一个首选项值应该被删除,一旦 commit() ,这将在实际首选项中完成。

请注意,在提交首选项时,无论您是在此编辑器上放置方法之前还是之后调用remove,都会首先执行所有删除操作。

Parameters
key String: The name of the preference to remove.
Returns
SharedPreferences.Editor Returns a reference to the same Editor object, so you can chain put calls together.

Hooray!