AppSearchSchema.BooleanPropertyConfig.Builder


public static final class AppSearchSchema.BooleanPropertyConfig.Builder
extends Object

java.lang.Object
   ↳ android.app.appsearch.AppSearchSchema.BooleanPropertyConfig.Builder


Builder for BooleanPropertyConfig.

Summary

Public constructors

Builder(String propertyName)

Creates a new BooleanPropertyConfig.Builder.

Public methods

AppSearchSchema.BooleanPropertyConfig build()

Constructs a new BooleanPropertyConfig from the contents of this builder.

AppSearchSchema.BooleanPropertyConfig.Builder setCardinality(int cardinality)

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

AppSearchSchema.BooleanPropertyConfig.Builder setScoringEnabled(boolean scoringEnabled)

Sets the property enabled or disabled for scoring.

Inherited methods

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

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

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

Added in API level 31
public Builder (String propertyName)

Creates a new BooleanPropertyConfig.Builder.

Parameters
propertyName String: This value cannot be null.

Public methods

build

Added in API level 31
public AppSearchSchema.BooleanPropertyConfig build ()

Constructs a new BooleanPropertyConfig from the contents of this builder.

Returns
AppSearchSchema.BooleanPropertyConfig This value cannot be null.

setCardinality

Added in API level 31
public AppSearchSchema.BooleanPropertyConfig.Builder setCardinality (int cardinality)

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

If this method is not called, the default cardinality is AppSearchSchema.PropertyConfig.CARDINALITY_OPTIONAL.

Returns
AppSearchSchema.BooleanPropertyConfig.Builder This value cannot be null.

setScoringEnabled

public AppSearchSchema.BooleanPropertyConfig.Builder setScoringEnabled (boolean scoringEnabled)

Sets the property enabled or disabled for scoring.

If this method is not called, the default value is false.

If enabled, it can be used in the advanced ranking expression via the function of 'getScorableProperty'.

For the detailed documentation, see SearchSpec.Builder.setRankingStrategy(java.lang.String).

Parameters
scoringEnabled boolean

Returns
AppSearchSchema.BooleanPropertyConfig.Builder This value cannot be null.