PropertyConfig

Kotlin |Java

abstract class PropertyConfig

kotlin.Any
↳	android.app.appsearch.AppSearchSchema.PropertyConfig

Known Direct Subclasses

AppSearchSchema.BooleanPropertyConfig, AppSearchSchema.BytesPropertyConfig, AppSearchSchema.DocumentPropertyConfig, AppSearchSchema.DoublePropertyConfig, AppSearchSchema.LongPropertyConfig, AppSearchSchema.StringPropertyConfig

AppSearchSchema.BooleanPropertyConfig	Configuration for a property containing a boolean.
AppSearchSchema.BytesPropertyConfig	Configuration for a property containing a byte array.
AppSearchSchema.DocumentPropertyConfig	Configuration for a property containing another Document.
AppSearchSchema.DoublePropertyConfig	Configuration for a property containing a double-precision decimal number.
AppSearchSchema.LongPropertyConfig	Configuration for a property containing a 64-bit integer.
AppSearchSchema.StringPropertyConfig	Configuration for a property of type String in a Document.

Common configuration for a single property (field) in a Document.

For example, an EmailMessage would be a type and the subject would be a property.

Summary

Constants
static Int	`CARDINALITY_OPTIONAL` Zero or one value [0,1].
static Int	`CARDINALITY_REPEATED` Any number of items (including zero) [0.
static Int	`CARDINALITY_REQUIRED` Exactly one value [1].

Public methods
open Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
open Int	`getCardinality()` Returns the cardinality of the property (whether it is optional, required or repeated).
open String	`getName()` Returns the name of this property.
open Int	`hashCode()`
open String	`toString()` Returns a string representation of the object.

Constants

CARDINALITY_OPTIONAL

Added in API level 31

static val CARDINALITY_OPTIONAL: Int

Zero or one value [0,1].

Value: 2

CARDINALITY_REPEATED

Added in API level 31

static val CARDINALITY_REPEATED: Int

Any number of items (including zero) [0...*].

Value: 1

CARDINALITY_REQUIRED

Added in API level 31

static val CARDINALITY_REQUIRED: Int

Exactly one value [1].

Value: 3

Public methods

equals

Added in API level 31

open 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.
`other`	Any?: This value may be `null`.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getCardinality

Added in API level 31

open fun getCardinality(): Int

Returns the cardinality of the property (whether it is optional, required or repeated).

Return
`Int`	Value is `android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_REPEATED`, `android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_OPTIONAL`, or `android.app.appsearch.AppSearchSchema.PropertyConfig#CARDINALITY_REQUIRED`

getName

Added in API level 31

open fun getName(): String

Returns the name of this property.

Return
`String`	This value cannot be `null`.

hashCode

Added in API level 31

open fun hashCode(): Int

Return
`Int`	a hash code value for this object.

toString

Added in API level 31

open fun toString(): String

Returns a string representation of the object.

Return
`String`	This value cannot be `null`.