public class VolumeInfo extends Object implements Parcelable
DiskInfo
, an emulated volume above some other
storage medium, or a standalone container like an ASEC or OBB.
Volumes may be mounted with various flags:
MOUNT_FLAG_PRIMARY
means the volume provides primary external
storage, historically found at /sdcard
.
MOUNT_FLAG_VISIBLE
means the volume is visible to third-party
apps for direct filesystem access. The system should send out relevant
storage broadcasts and index any media on visible volumes. Visible volumes
are considered a more stable part of the device, which is why we take the
time to index them. In particular, transient volumes like USB OTG devices
should not be marked as visible; their contents should be surfaced
to apps through the Storage Access Framework.
Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>
Modifier and Type | Field and Description |
---|---|
static String |
ACTION_VOLUME_STATE_CHANGED |
static Parcelable.Creator<VolumeInfo> |
CREATOR |
DiskInfo |
disk |
static String |
EXTRA_VOLUME_ID |
static String |
EXTRA_VOLUME_STATE |
String |
fsLabel |
String |
fsType |
String |
fsUuid |
String |
id
vold state
|
static String |
ID_EMULATED_INTERNAL
Real volume representing internal emulated storage
|
static String |
ID_PRIVATE_INTERNAL
Stub volume representing internal private storage
|
String |
internalPath |
static int |
MOUNT_FLAG_PRIMARY |
static int |
MOUNT_FLAG_VISIBLE |
int |
mountFlags |
int |
mountUserId |
String |
partGuid |
String |
path |
int |
state |
static int |
STATE_BAD_REMOVAL |
static int |
STATE_CHECKING |
static int |
STATE_EJECTING |
static int |
STATE_FORMATTING |
static int |
STATE_MOUNTED |
static int |
STATE_MOUNTED_READ_ONLY |
static int |
STATE_REMOVED |
static int |
STATE_UNMOUNTABLE |
static int |
STATE_UNMOUNTED |
int |
type |
static int |
TYPE_ASEC |
static int |
TYPE_EMULATED |
static int |
TYPE_OBB |
static int |
TYPE_PRIVATE |
static int |
TYPE_PUBLIC |
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_ELIDE_DUPLICATES, PARCELABLE_WRITE_RETURN_VALUE
Constructor and Description |
---|
VolumeInfo(Parcel parcel) |
VolumeInfo(String id,
int type,
DiskInfo disk,
String partGuid) |
Modifier and Type | Method and Description |
---|---|
Intent |
buildBrowseIntent()
Build an intent to browse the contents of this volume.
|
static int |
buildStableMtpStorageId(String fsUuid) |
StorageVolume |
buildStorageVolume(Context context,
int userId,
boolean reportUnmounted) |
VolumeInfo |
clone()
Creates and returns a copy of this object.
|
int |
describeContents()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation.
|
void |
dump(IndentingPrintWriter pw) |
boolean |
equals(Object o)
Indicates whether some other object is "equal to" this one.
|
static String |
getBroadcastForEnvironment(String envState) |
static String |
getBroadcastForState(int state) |
String |
getDescription() |
static Comparator<VolumeInfo> |
getDescriptionComparator() |
DiskInfo |
getDisk() |
String |
getDiskId() |
static String |
getEnvironmentForState(int state) |
String |
getFsUuid() |
String |
getId() |
File |
getInternalPath() |
File |
getInternalPathForUser(int userId)
Path which is accessible to apps holding
android.Manifest.permission#WRITE_MEDIA_STORAGE . |
int |
getMountUserId() |
File |
getPath() |
File |
getPathForUser(int userId) |
int |
getState() |
int |
getStateDescription() |
int |
getType() |
int |
hashCode()
Returns a hash code value for the object.
|
boolean |
isMountedReadable() |
boolean |
isMountedWritable() |
boolean |
isPrimary() |
boolean |
isPrimaryPhysical() |
boolean |
isVisible() |
boolean |
isVisibleForRead(int userId) |
boolean |
isVisibleForWrite(int userId) |
String |
toString()
Returns a string representation of the object.
|
void |
writeToParcel(Parcel parcel,
int flags)
Flatten this object in to a Parcel.
|
public static final String ACTION_VOLUME_STATE_CHANGED
public static final String EXTRA_VOLUME_ID
public static final String EXTRA_VOLUME_STATE
public static final String ID_PRIVATE_INTERNAL
public static final String ID_EMULATED_INTERNAL
public static final int TYPE_PUBLIC
public static final int TYPE_PRIVATE
public static final int TYPE_EMULATED
public static final int TYPE_ASEC
public static final int TYPE_OBB
public static final int STATE_UNMOUNTED
public static final int STATE_CHECKING
public static final int STATE_MOUNTED
public static final int STATE_MOUNTED_READ_ONLY
public static final int STATE_FORMATTING
public static final int STATE_EJECTING
public static final int STATE_UNMOUNTABLE
public static final int STATE_REMOVED
public static final int STATE_BAD_REMOVAL
public static final int MOUNT_FLAG_PRIMARY
public static final int MOUNT_FLAG_VISIBLE
public final String id
public final int type
public final DiskInfo disk
public final String partGuid
public int mountFlags
public int mountUserId
public int state
public String fsType
public String fsUuid
public String fsLabel
public String path
public String internalPath
public static final Parcelable.Creator<VolumeInfo> CREATOR
public VolumeInfo(Parcel parcel)
public static String getEnvironmentForState(int state)
public static String getBroadcastForState(int state)
public static Comparator<VolumeInfo> getDescriptionComparator()
public String getId()
public DiskInfo getDisk()
public String getDiskId()
public int getType()
public int getState()
public int getStateDescription()
public String getFsUuid()
public int getMountUserId()
public String getDescription()
public boolean isMountedReadable()
public boolean isMountedWritable()
public boolean isPrimary()
public boolean isPrimaryPhysical()
public boolean isVisible()
public boolean isVisibleForRead(int userId)
public boolean isVisibleForWrite(int userId)
public File getPath()
public File getInternalPath()
public File getPathForUser(int userId)
public File getInternalPathForUser(int userId)
android.Manifest.permission#WRITE_MEDIA_STORAGE
.public StorageVolume buildStorageVolume(Context context, int userId, boolean reportUnmounted)
public static int buildStableMtpStorageId(String fsUuid)
public Intent buildBrowseIntent()
TYPE_EMULATED
or TYPE_PUBLIC
.public String toString()
Object
toString
method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@
', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
public void dump(IndentingPrintWriter pw)
public VolumeInfo clone()
Object
x
, the expression:
will be true, and that the expression:x.clone() != x
will bex.clone().getClass() == x.getClass()
true
, but these are not absolute requirements.
While it is typically the case that:
will bex.clone().equals(x)
true
, this is not an absolute requirement.
By convention, the returned object should be obtained by calling
super.clone
. If a class and all of its superclasses (except
Object
) obey this convention, it will be the case that
x.clone().getClass() == x.getClass()
.
By convention, the object returned by this method should be independent
of this object (which is being cloned). To achieve this independence,
it may be necessary to modify one or more fields of the object returned
by super.clone
before returning it. Typically, this means
copying any mutable objects that comprise the internal "deep structure"
of the object being cloned and replacing the references to these
objects with references to the copies. If a class contains only
primitive fields or references to immutable objects, then it is usually
the case that no fields in the object returned by super.clone
need to be modified.
The method clone
for class Object
performs a
specific cloning operation. First, if the class of this object does
not implement the interface Cloneable
, then a
CloneNotSupportedException
is thrown. Note that all arrays
are considered to implement the interface Cloneable
and that
the return type of the clone
method of an array type T[]
is T[]
where T is any reference or primitive type.
Otherwise, this method creates a new instance of the class of this
object and initializes all its fields with exactly the contents of
the corresponding fields of this object, as if by assignment; the
contents of the fields are not themselves cloned. Thus, this method
performs a "shallow copy" of this object, not a "deep copy" operation.
The class Object
does not itself implement the interface
Cloneable
, so calling the clone
method on an object
whose class is Object
will result in throwing an
exception at run time.
public boolean equals(Object o)
Object
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
equals
in class Object
o
- the reference object with which to compare.true
if this object is the same as the obj
argument; false
otherwise.Object.hashCode()
,
HashMap
public int hashCode()
Object
HashMap
.
The general contract of hashCode
is:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
Object.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.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
JavaTM programming language.)
hashCode
in class Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
public int describeContents()
Parcelable
Parcelable.writeToParcel(Parcel, int)
,
the return value of this method must include the
Parcelable.CONTENTS_FILE_DESCRIPTOR
bit.describeContents
in interface Parcelable
Parcelable.CONTENTS_FILE_DESCRIPTOR
public void writeToParcel(Parcel parcel, int flags)
Parcelable
writeToParcel
in interface Parcelable
parcel
- The Parcel in which the object should be written.flags
- Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE
.