PropertyConfig
abstract class PropertyConfig
| kotlin.Any | |
| ↳ | android.app.appsearch.AppSearchSchema.PropertyConfig |
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 |
Zero or one value [0,1]. |
| static Int |
Any number of items (including zero) [0. |
| static Int |
Exactly one value [1]. |
| Public methods | |
|---|---|
| open Boolean |
Indicates whether some other object is "equal to" this one. |
| open Int |
Returns the cardinality of the property (whether it is optional, required or repeated). |
| open String |
Returns a natural language description of this property. |
| open String |
getName()Returns the name of this property. |
| open Int |
hashCode()Returns a hash code value for the object. |
| open String |
toString()Returns a string representation of the object. |
Constants
CARDINALITY_OPTIONAL
static val CARDINALITY_OPTIONAL: Int
Zero or one value [0,1].
Value: 2CARDINALITY_REPEATED
static val CARDINALITY_REPEATED: Int
Any number of items (including zero) [0...*].
Value: 1CARDINALITY_REQUIRED
static val CARDINALITY_REQUIRED: Int
Exactly one value [1].
Value: 3Public methods
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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
open fun getCardinality(): Int
Returns the cardinality of the property (whether it is optional, required or repeated).
| Return | |
|---|---|
Int |
Value is one of the following: |
getDescription
open fun getDescription(): String
Returns a natural language description of this property.
Ex. The description for the "homeAddress" property of a "Person" type could be "the address at which this person lives".
This information is purely to help apps consuming this type the semantic meaning of its properties. This field has no effect in AppSearch - it is just stored with the AppSearchSchema. If the description is not set, then this method will return an empty string.
| Return | |
|---|---|
String |
This value cannot be null. |
getName
open fun getName(): String
Returns the name of this property.
| Return | |
|---|---|
String |
This value cannot be null. |
hashCode
open fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
toString
open fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
This value cannot be null. |