Most visited

Recently visited

Added in API level 24

StorageVolume

public final class StorageVolume
extends Object implements Parcelable

java.lang.Object
   ↳ android.os.storage.StorageVolume


有关特定用户的共享/外部存储卷的信息。

一个设备总是有一个(也是唯一的)主存储卷,但它可能有额外的卷,如SD卡和USB驱动器。 此对象表示特定用户的存储卷的逻辑视图:不同用户可能对同一物理卷具有不同视图(例如,如果该卷是内置模拟存储)。

存储卷未必安装,应用程序应使用 getState()来验证其状态。

愿意读取或写入此存储卷的应用程序需要首先获得用户的许可,这可以通过以下方式实现:

它可以通过 getStorageVolumes()getPrimaryStorageVolume()获得,也可以作为一些额外的广播(参见 EXTRA_STORAGE_VOLUME )。

有关共享/外部存储语义的更多信息,请参阅 getExternalStorageDirectory()

Summary

Constants

String EXTRA_STORAGE_VOLUME

该名称 Parcelable在额外 ACTION_MEDIA_REMOVEDACTION_MEDIA_UNMOUNTEDACTION_MEDIA_CHECKINGACTION_MEDIA_NOFSACTION_MEDIA_MOUNTEDACTION_MEDIA_SHAREDACTION_MEDIA_BAD_REMOVALACTION_MEDIA_UNMOUNTABLE ,并 ACTION_MEDIA_EJECT包含广播 StorageVolume

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<StorageVolume> CREATOR

Public methods

Intent createAccessIntent(String directoryName)

建立一个意图,在获得用户的批准后允许访问标准存储目录或整个卷。

int describeContents()

描述此Parcelable实例的封送表示中包含的特殊对象的种类。

boolean equals(Object obj)

指示其他某个对象是否“等于”这一个。

String getDescription(Context context)

返回卷的用户可见描述。

String getState()

返回卷的当前状态。

String getUuid()

获取卷UUID(如果有)。

int hashCode()

返回对象的哈希码值。

boolean isEmulated()

如果模拟量,则返回true。

boolean isPrimary()

如果该卷是主共享/外部存储(由 getExternalStorageDirectory()支持的卷),则返回true。

boolean isRemovable()

如果卷是可移动的,则返回true。

String toString()

返回对象的字符串表示形式。

void writeToParcel(Parcel parcel, int flags)

将此对象平铺到一个包裹中。

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Constants

EXTRA_STORAGE_VOLUME

Added in API level 24
String EXTRA_STORAGE_VOLUME

该名称 Parcelable在额外 ACTION_MEDIA_REMOVEDACTION_MEDIA_UNMOUNTEDACTION_MEDIA_CHECKINGACTION_MEDIA_NOFSACTION_MEDIA_MOUNTEDACTION_MEDIA_SHAREDACTION_MEDIA_BAD_REMOVALACTION_MEDIA_UNMOUNTABLE ,并 ACTION_MEDIA_EJECT包含广播 StorageVolume

常量值:“android.os.storage.extra.STORAGE_VOLUME”

Fields

CREATOR

Added in API level 24
Creator<StorageVolume> CREATOR

Public methods

createAccessIntent

Added in API level 24
Intent createAccessIntent (String directoryName)

建立一个意图,在获得用户的批准后允许访问标准存储目录或整个卷。

当被调用时,系统将要求用户授予对所请求目录(及其后代)的访问权限。 请求的结果将通过onActivityResult方法返回给活动。

要获得对子孙后代(子孙,孙子等)文档的访问权限, buildDocumentUriUsingTree(Uri, String)buildChildDocumentsUriUsingTree(Uri, String)与返回的URI一起使用。

如果你的应用程序只需要存储内部数据,可以考虑使用 Context.getExternalFilesDirsgetExternalCacheDirs() ,或 getExternalMediaDirs() ,它不需要的权限读取或写入。

访问整个卷仅适用于非主卷(对于主卷,应用程序可以使用 READ_EXTERNAL_STORAGEWRITE_EXTERNAL_STORAGE权限),因此用户应该谨慎使用,因为用户在询问整个卷访问时更可能拒绝访问比特定的目录。

Parameters
directoryName String: must be one of DIRECTORY_MUSIC, DIRECTORY_PODCASTS, DIRECTORY_RINGTONES, DIRECTORY_ALARMS, DIRECTORY_NOTIFICATIONS, DIRECTORY_PICTURES, DIRECTORY_MOVIES, DIRECTORY_DOWNLOADS, DIRECTORY_DCIM, or DIRECTORY_DOCUMENTS, or {code null} to request access to the entire volume.
Returns
Intent intent to request access, or null if the requested directory is invalid for that volume.

也可以看看:

describeContents

Added in API level 24
int describeContents ()

描述此Parcelable实例的封送表示中包含的特殊对象的种类。 例如,如果对象将在writeToParcel(Parcel, int)的输出中包含writeToParcel(Parcel, int) ,则此方法的返回值必须包含CONTENTS_FILE_DESCRIPTOR位。

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

equals

Added in API level 24
boolean equals (Object obj)

指示其他某个对象是否“等于”这一个。

equals方法在非空对象引用上实现等价关系:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

equals方法Object实现了对象上最可能的等价关系; 也就是说,对于任何非空参考值xy ,当且仅当xy引用同一对象( x == y具有值true )时,此方法返回true

请注意,无论何时覆盖此方法,通常都必须覆盖 hashCode方法,以维护 hashCode方法的常规协定,该 hashCode声明相等对象必须具有相同的哈希代码。

Parameters
obj Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getDescription

Added in API level 24
String getDescription (Context context)

返回卷的用户可见描述。

Parameters
context Context
Returns
String the volume description

getUuid

Added in API level 24
String getUuid ()

获取卷UUID(如果有)。

Returns
String

hashCode

Added in API level 24
int hashCode ()

返回对象的哈希码值。 这种方法支持散列表的好处,例如HashMap提供的HashMap

hashCode的总合同是:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

尽可能合理实用,类Object定义的hashCode方法确实为不同的对象返回不同的整数。 (这通常通过将对象的内部地址转换为整数来实现,但Java TM编程语言不需要此实现技术。)

Returns
int a hash code value for this object.

isEmulated

Added in API level 24
boolean isEmulated ()

如果模拟量,则返回true。

Returns
boolean is removable

isPrimary

Added in API level 24
boolean isPrimary ()

如果该卷是主共享/外部存储(即由 getExternalStorageDirectory()支持的卷),则返回true。

Returns
boolean

isRemovable

Added in API level 24
boolean isRemovable ()

如果卷是可移动的,则返回true。

Returns
boolean is removable

toString

Added in API level 24
String toString ()

返回对象的字符串表示形式。 通常, toString方法返回一个字符串,用于“文本地表示”该对象。 结果应该是一个简洁但内容丰富的表述,对于一个人来说很容易阅读。 建议所有子类重写此方法。

ObjecttoString方法返回一个字符串,其中包含对象为实例的类的名称,符号字符“ @ ”以及对象的哈希代码的无符号十六进制表示形式。 换句话说,这个方法返回一个字符串,其值等于:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

Added in API level 24
void writeToParcel (Parcel parcel, 
                int flags)

将此对象平铺到一个包裹中。

Parameters
parcel Parcel: The Parcel in which the object should be written.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

Hooray!