Added in API level 26

Path

class Path : Parcelable
kotlin.Any
   ↳ android.provider.DocumentsContract.Path

Holds a path from a document to a particular document under it. It may also contains the root ID where the path resides.

Summary

Inherited constants
Public constructors
Path(rootId: String?, path: MutableList<String!>!)

Creates a Path.
Public methods
Int

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
MutableList<String!>!

Returns the path.
String?

Returns the root id or null if the calling package doesn't have permission to access root information.
Int

String

Unit
writeToParcel(dest: Parcel, flags: Int)
Properties
static Parcelable.Creator<DocumentsContract.Path!>

Public constructors

Path

Added in API level 26
Path(
    rootId: String?, 
    path: MutableList<String!>!)

Creates a Path.

Parameters
rootId String?: the ID of the root. May be null.
path MutableList<String!>!: the list of document ID from the parent document at position 0 to the child document.

Public methods

describeContents

Added in API level 26
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 26
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • 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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getPath

Added in API level 26
fun getPath(): MutableList<String!>!

Returns the path. The path is trimmed to the top of tree if calling package doesn't have permission to access those documents.

getRootId

Added in API level 26
fun getRootId(): String?

Returns the root id or null if the calling package doesn't have permission to access root information.

hashCode

Added in API level 26
fun hashCode(): Int
Return
Int a hash code value for this object.

toString

Added in API level 26
fun toString(): String
Return
String a string representation of the object.

writeToParcel

Added in API level 26
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit
Parameters
dest Parcel: The Parcel in which the object should be written. This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 26
static val CREATOR: Parcelable.Creator<DocumentsContract.Path!>