Known Direct Subclasses
AggregateRatingBuilder,
ConversationBuilder,
DigitalDocumentBuilder,
DigitalDocumentPermissionBuilder,
GeoShapeBuilder,
Indexable.Builder,
LocalBusinessBuilder,
MessageBuilder,
MusicAlbumBuilder,
MusicGroupBuilder,
MusicPlaylistBuilder,
MusicRecordingBuilder,
PersonBuilder,
PostalAddressBuilder,
ReservationBuilder
|
Class Overview
The basic abstract builder to construct an Indexable
.
Summary
Protected Constructors |
|
IndexableBuilder(String type)
Builder for a basic Indexable.
|
Public Methods |
final
Indexable
|
build()
Finalize building the object.
|
T
|
put(String key, boolean... values)
Sets one or multiple boolean values for a property.
|
T
|
put(String key, Indexable... values)
Sets one or multiple Indexable values for a property.
|
T
|
put(String key, String... values)
Sets one or multiple string values for a property.
|
T
|
put(String key, long... values)
Sets one or multiple long values for a property.
|
final
T
|
setDescription(String description)
Sets the optional description of the content.
|
final
T
|
setImage(String url)
Sets the image of the content.
|
T
|
setMetadata(Indexable.Metadata.Builder metadataBuilder)
Sets the metadata.
|
final
T
|
setName(String name)
Sets the name of the content, must not be null.
|
final
T
|
setSameAs(String webUrl)
Sets the corresponding web URL.
|
final
T
|
setUrl(String url)
Sets the URL.
|
[Expand]
Inherited Methods |
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
final
void
|
wait()
|
|
Protected Constructors
protected
IndexableBuilder
(String type)
Builder for a basic Indexable.
Parameters |
type |
String :
The schema.org type of the Indexable, must not be null or empty.
|
Public Methods
public
T
put
(String key, boolean... values)
Sets one or multiple boolean values for a property.
Parameters |
key |
String :
The schema.org property. Must not be null. |
values |
boolean :
The boolean values of the schema.org property. Null values are ignored.
|
public
T
put
(String key, Indexable... values)
Sets one or multiple Indexable
values for a property.
Parameters |
key |
String :
The schema.org property. Must not be null. |
values |
Indexable :
The values represented as an Indexable .
Null values are ignored. Indexable s must be
constructed using Indexable.Builder or convenience
methods.
|
public
T
put
(String key, String... values)
Sets one or multiple string values for a property.
Parameters |
key |
String :
The schema.org property. Must not be null. |
values |
String :
The string values of the schema.org property. Null values are ignored.
|
public
T
put
(String key, long... values)
Sets one or multiple long values for a property.
Parameters |
key |
String :
The schema.org property. Must not be null. |
values |
long :
The long values of the schema.org property. Null values are ignored.
|
public
final
T
setDescription
(String description)
Sets the optional description of the content.
Parameters |
description |
String :
The description of the content.
|
public
final
T
setImage
(String url)
Sets the image of the content.
Parameters |
url |
String :
The web URL or content
URI of the image.
|
Sets the metadata. If not invoked default metadata values are applied.
May only be called once and only on top-level Indexable
s.
public
final
T
setName
(String name)
Sets the name of the content, must not be null. For more information, visit these guidelines for providing
a descriptive name.
public
final
T
setSameAs
(String webUrl)
Sets the corresponding web URL. The web URL is a reference web page that unambiguously
indicates the item's identity.
Parameters |
webUrl |
String :
The reference web page that unambiguously indicates the item's identity.
|
public
final
T
setUrl
(String url)
Sets the URL. The URL must be openable by the app. This is mandatory to be set. The URL
uniquely identifies the Indexable
within the app.
Parameters |
url |
String :
The deep link URL which is not longer than Indexable.MAX_URL_LENGTH and
openable by the app. The URL must be handled by app intent filter. Find detailed
information on handling deep links here.
|
Protected Methods
protected
T
put
(String key, S... values)
Sets one or multiple Indexable
values for a property.
Parameters |
key |
String :
The schema.org property. Must not be null. |
values |
S :
The values represented as an IndexableBuilder . Null values are ignored.
|