Added in API level 29

ContentCaptureCondition


class ContentCaptureCondition : Parcelable
kotlin.Any
   ↳ android.view.contentcapture.ContentCaptureCondition

Defines a condition for when content capture should be allowed.

See ContentCaptureManager#getContentCaptureConditions() for more.

Summary

Constants
static Int

When set, package should use the LocusId#getId() as a regular expression (using the java.util.regex.Pattern format).

Inherited constants
Public constructors
ContentCaptureCondition(locusId: LocusId, flags: Int)

Default constructor.

Public methods
Int

Boolean
equals(other: Any?)

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

Int

Gets the flags associates with this condition.

LocusId

Gets the LocusId per se.

Int

String

Unit
writeToParcel(parcel: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<ContentCaptureCondition!>

Constants

FLAG_IS_REGEX

Added in API level 29
static val FLAG_IS_REGEX: Int

When set, package should use the LocusId#getId() as a regular expression (using the java.util.regex.Pattern format).

Value: 2

Public constructors

ContentCaptureCondition

Added in API level 29
ContentCaptureCondition(
    locusId: LocusId,
    flags: Int)

Default constructor.

Parameters
locusId LocusId: id of the condition, as defined by ContentCaptureContext#getLocusId(). This value cannot be null.
flags Int: either ContentCaptureCondition#FLAG_IS_REGEX (to use a regular expression match) or 0 (in which case the LocusId must be an exact match of the LocusId used in the ContentCaptureContext). Value is either 0 or android.view.contentcapture.ContentCaptureCondition#FLAG_IS_REGEX

Public methods

describeContents

Added in API level 29
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 29
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 This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getFlags

Added in API level 29
fun getFlags(): Int

Gets the flags associates with this condition.

Return
Int either ContentCaptureCondition#FLAG_IS_REGEX or 0. Value is either 0 or android.view.contentcapture.ContentCaptureCondition#FLAG_IS_REGEX

getLocusId

Added in API level 29
fun getLocusId(): LocusId

Gets the LocusId per se.

Return
LocusId This value cannot be null.

hashCode

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

toString

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

writeToParcel

Added in API level 29
fun writeToParcel(
    parcel: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest 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
parcel Parcel: This value cannot be null.

Properties

CREATOR

Added in API level 29
static val CREATOR: Parcelable.Creator<ContentCaptureCondition!>