Commit e295a15d by samrobinson Committed by Oliver Woodman

Add javadoc to the MediaMetadata setters.

#minor-release

PiperOrigin-RevId: 372549185
parent 1c8f91c1
...@@ -62,52 +62,65 @@ public final class MediaMetadata implements Bundleable { ...@@ -62,52 +62,65 @@ public final class MediaMetadata implements Bundleable {
this.overallRating = mediaMetadata.overallRating; this.overallRating = mediaMetadata.overallRating;
} }
/** Sets the optional track title. */ /** Sets the title. */
public Builder setTitle(@Nullable CharSequence title) { public Builder setTitle(@Nullable CharSequence title) {
this.title = title; this.title = title;
return this; return this;
} }
/** Sets the artist. */
public Builder setArtist(@Nullable CharSequence artist) { public Builder setArtist(@Nullable CharSequence artist) {
this.artist = artist; this.artist = artist;
return this; return this;
} }
/** Sets the album title. */
public Builder setAlbumTitle(@Nullable CharSequence albumTitle) { public Builder setAlbumTitle(@Nullable CharSequence albumTitle) {
this.albumTitle = albumTitle; this.albumTitle = albumTitle;
return this; return this;
} }
/** Sets the album artist. */
public Builder setAlbumArtist(@Nullable CharSequence albumArtist) { public Builder setAlbumArtist(@Nullable CharSequence albumArtist) {
this.albumArtist = albumArtist; this.albumArtist = albumArtist;
return this; return this;
} }
/** Sets the display title. */
public Builder setDisplayTitle(@Nullable CharSequence displayTitle) { public Builder setDisplayTitle(@Nullable CharSequence displayTitle) {
this.displayTitle = displayTitle; this.displayTitle = displayTitle;
return this; return this;
} }
/**
* Sets the subtitle.
*
* <p>This is the secondary title of the media, unrelated to closed captions.
*/
public Builder setSubtitle(@Nullable CharSequence subtitle) { public Builder setSubtitle(@Nullable CharSequence subtitle) {
this.subtitle = subtitle; this.subtitle = subtitle;
return this; return this;
} }
/** Sets the description. */
public Builder setDescription(@Nullable CharSequence description) { public Builder setDescription(@Nullable CharSequence description) {
this.description = description; this.description = description;
return this; return this;
} }
/** Sets the media {@link Uri}. */
public Builder setMediaUri(@Nullable Uri mediaUri) { public Builder setMediaUri(@Nullable Uri mediaUri) {
this.mediaUri = mediaUri; this.mediaUri = mediaUri;
return this; return this;
} }
/** Sets the user {@link Rating}. */
public Builder setUserRating(@Nullable Rating userRating) { public Builder setUserRating(@Nullable Rating userRating) {
this.userRating = userRating; this.userRating = userRating;
return this; return this;
} }
/** Sets the overall {@link Rating}. */
public Builder setOverallRating(@Nullable Rating overallRating) { public Builder setOverallRating(@Nullable Rating overallRating) {
this.overallRating = overallRating; this.overallRating = overallRating;
return this; return this;
...@@ -160,15 +173,29 @@ public final class MediaMetadata implements Bundleable { ...@@ -160,15 +173,29 @@ public final class MediaMetadata implements Bundleable {
/** Empty {@link MediaMetadata}. */ /** Empty {@link MediaMetadata}. */
public static final MediaMetadata EMPTY = new MediaMetadata.Builder().build(); public static final MediaMetadata EMPTY = new MediaMetadata.Builder().build();
/** Optional title. */
@Nullable public final CharSequence title; @Nullable public final CharSequence title;
/** Optional artist. */
@Nullable public final CharSequence artist; @Nullable public final CharSequence artist;
/** Optional album title. */
@Nullable public final CharSequence albumTitle; @Nullable public final CharSequence albumTitle;
/** Optional album artist. */
@Nullable public final CharSequence albumArtist; @Nullable public final CharSequence albumArtist;
/** Optional display title. */
@Nullable public final CharSequence displayTitle; @Nullable public final CharSequence displayTitle;
/**
* Optional subtitle.
*
* <p>This is the secondary title of the media, unrelated to closed captions.
*/
@Nullable public final CharSequence subtitle; @Nullable public final CharSequence subtitle;
/** Optional description. */
@Nullable public final CharSequence description; @Nullable public final CharSequence description;
/** Optional media {@link Uri}. */
@Nullable public final Uri mediaUri; @Nullable public final Uri mediaUri;
/** Optional user {@link Rating}. */
@Nullable public final Rating userRating; @Nullable public final Rating userRating;
/** Optional overall {@link Rating}. */
@Nullable public final Rating overallRating; @Nullable public final Rating overallRating;
private MediaMetadata(Builder builder) { private MediaMetadata(Builder builder) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment