IndexableBuilder

public abstract classIndexableBuilderextendsObject
Known Direct Subclasses

The basic abstract builder to construct anIndexable.

Protected Constructor Summary

IndexableBuilder(Stringtype)
Builder for a basic Indexable.

Public Method Summary

finalIndexable
build()
Finalize building the object.
T
put(Stringkey, double... values)
Sets one or multiple double values for a property, replacing its previous values.
T
put(Stringkey, boolean... values)
Sets one or multiple boolean values for a property, replacing its previous values.
T
put(Stringkey, byte[] byteArray)
Sets byte array for a property, replacing its previous values.
T
put(Stringkey, Indexable... values)
Sets one or multipleIndexable values for a property, replacing its previous values.
T
put(Stringkey, String... values)
Sets one or multiple string values for a property, replacing its previous values.
T
put(Stringkey, long... values)
Sets one or multiple long values for a property, replacing its previous values.
T
setAlternateName(String... alternateNames)
Sets the alternate names for the content.
final T
setDescription(Stringdescription)
Sets the optional description of the content.
T
setId(Stringid)
Sets the ID for the Indexable.
final T
setImage(Stringurl)
Sets the image of the content.
final <S extendsIndexableBuilder<?>> T
setIsPartOf(S... collections)
Sets the sub-group or collection that this Indexable is part of.
final T
setKeywords(String...keywords)
Sets the keywords of the Indexable.
T
setMetadata(Indexable.Metadata.Builder metadataBuilder)
Sets the metadata.
final T
setName(Stringname)
Sets the name of the content, must not be null.
final T
setSameAs(StringwebUrl)
Sets the corresponding web URL.
final T
setUrl(Stringurl)
Sets the URL.

Protected Method Summary

<S extendsIndexableBuilder<?>> T
put(Stringkey, S... values)
Sets one or multipleIndexable values for a property.

Inherited Method Summary

Protected Constructors

protectedIndexableBuilder(Stringtype)

Builder for a basic Indexable.

Parameters
type The schema.org type of the Indexable, must not be null or empty.

Public Methods

public finalIndexable build()

Finalize building the object. TheIndexable being returned can be put into the index via theAppIndex interface.

public Tput(Stringkey, double... values)

Sets one or multiple double values for a property, replacing its previous values.

Parameters
key The schema.org property. Must not be null.
values The boolean values of the schema.org property.

public Tput(Stringkey, boolean... values)

Sets one or multiple boolean values for a property, replacing its previous values.

Parameters
key The schema.org property. Must not be null.
values The boolean values of the schema.org property.

public Tput(Stringkey, byte[] byteArray)

Sets byte array for a property, replacing its previous values.

This can be used to cache custom data in the Indexable that the client application can use during querying (to avoid having to look up the data in their own storage).

Parameters
key The schema.org property. Must not be null.
byteArray The byte array of the schema.org property.

public Tput(Stringkey,Indexable... values)

Sets one or multipleIndexable values for a property, replacing its previous values.

Parameters
key The schema.org property. Must not be null.
values The values represented as anIndexable. Null values are ignored.Indexable values must be constructed using Indexable.Metadata.Builderor convenience methods.
Throws
AppIndexInvalidArgumentException

public Tput(Stringkey,String...values)

Sets one or multiple string values for a property, replacing its previous values.

Parameters
key The schema.org property. Must not be null.
values The string values of the schema.org property. Null values are ignored.

public Tput(Stringkey, long... values)

Sets one or multiple long values for a property, replacing its previous values.

Parameters
key The schema.org property. Must not be null.
values The long values of the schema.org property.

public TsetAlternateName(String... alternateNames)

Sets the alternate names for the content.

public final TsetDescription(String description)

Sets the optional description of the content.

Parameters
description The description of the content.

public TsetId(Stringid)

Sets the ID for the Indexable.

public final TsetImage(Stringurl)

Sets the image of the content.

Parameters
url The web URL or content URIof the image.

public final TsetIsPartOf(S... collections)

Sets the sub-group or collection that this Indexable is part of.

public final TsetKeywords(String... keywords)

Sets the keywords of the Indexable. For example, email message can have keywords like promotion, finance; photograph can have the keywords for people, object and the place name where the photograph was taken.

Parameters
keywords The keywords of the Indexable. Null values are ignored.

public TsetMetadata(Indexable.Metadata.Builder metadataBuilder)

Sets the metadata. If not invoked default metadata values are applied.

May only be called once and only on top-levelIndexable values.

Parameters
metadataBuilder The Indexable.Metadata.Builderwhich builds the metadata.

public final TsetName(Stringname)

Sets the name of the content, must not be null. For more information, visitthese guidelinesfor providing a descriptive name.

public final TsetSameAs(StringwebUrl)

Sets the corresponding web URL. The web URL is a reference web page that unambiguously indicates the item's identity.

Parameters
webUrl The reference web page that unambiguously indicates the item's identity.

public final TsetUrl(Stringurl)

Sets the URL. The URL must be openable by the app. This is mandatory to be set. The URL uniquely identifies theIndexable within the app.

Parameters
url The deep link URL which is not longer thanIndexable.MAX_URL_LENGTHand openable by the app. The URL must be handled by app intent filter. Find detailed information on handling deep linkshere.

Protected Methods

protected Tput(Stringkey, S... values)

Sets one or multipleIndexable values for a property.

Parameters
key The schema.org property. Must not be null.
values The values represented as an IndexableBuilder.Null values are ignored.