Explicitly document every overridden method in ForwardingPlayer

This makes the delegation model more explicit, and prevents the javadoc
compiler from just pulling in the Player javadoc automatically - which
can lead to some confusion when some method definitions in Player depend
on other methods (e.g. seekForward() is defined in terms of
getSeekForwardIncrement()).

Issue: google/ExoPlayer#9897

#minor-release

PiperOrigin-RevId: 426359004
This commit is contained in:
ibaker 2022-02-04 11:15:47 +00:00 committed by Ian Baker
parent 7b9eaaed14
commit 9a5238b0f7

View File

@ -39,222 +39,266 @@ public class ForwardingPlayer implements Player {
this.player = player;
}
/** Calls {@link Player#getApplicationLooper()} on the delegate and returns the result. */
@Override
public Looper getApplicationLooper() {
return player.getApplicationLooper();
}
/** Calls {@link Player#addListener(Listener)} on the delegate. */
@Override
public void addListener(Listener listener) {
player.addListener(new ForwardingListener(this, listener));
}
/** Calls {@link Player#removeListener(Listener)} on the delegate. */
@Override
public void removeListener(Listener listener) {
player.removeListener(new ForwardingListener(this, listener));
}
/** Calls {@link Player#setMediaItems(List)} on the delegate. */
@Override
public void setMediaItems(List<MediaItem> mediaItems) {
player.setMediaItems(mediaItems);
}
/** Calls {@link Player#setMediaItems(List, boolean)} ()} on the delegate. */
@Override
public void setMediaItems(List<MediaItem> mediaItems, boolean resetPosition) {
player.setMediaItems(mediaItems, resetPosition);
}
/** Calls {@link Player#setMediaItems(List, int, long)} on the delegate. */
@Override
public void setMediaItems(List<MediaItem> mediaItems, int startIndex, long startPositionMs) {
player.setMediaItems(mediaItems, startIndex, startPositionMs);
}
/** Calls {@link Player#setMediaItem(MediaItem)} on the delegate. */
@Override
public void setMediaItem(MediaItem mediaItem) {
player.setMediaItem(mediaItem);
}
/** Calls {@link Player#setMediaItem(MediaItem, long)} on the delegate. */
@Override
public void setMediaItem(MediaItem mediaItem, long startPositionMs) {
player.setMediaItem(mediaItem, startPositionMs);
}
/** Calls {@link Player#setMediaItem(MediaItem, boolean)} on the delegate. */
@Override
public void setMediaItem(MediaItem mediaItem, boolean resetPosition) {
player.setMediaItem(mediaItem, resetPosition);
}
/** Calls {@link Player#addMediaItem(MediaItem)} on the delegate. */
@Override
public void addMediaItem(MediaItem mediaItem) {
player.addMediaItem(mediaItem);
}
/** Calls {@link Player#addMediaItem(int, MediaItem)} on the delegate. */
@Override
public void addMediaItem(int index, MediaItem mediaItem) {
player.addMediaItem(index, mediaItem);
}
/** Calls {@link Player#addMediaItems(List)} on the delegate. */
@Override
public void addMediaItems(List<MediaItem> mediaItems) {
player.addMediaItems(mediaItems);
}
/** Calls {@link Player#addMediaItems(int, List)} on the delegate. */
@Override
public void addMediaItems(int index, List<MediaItem> mediaItems) {
player.addMediaItems(index, mediaItems);
}
/** Calls {@link Player#moveMediaItem(int, int)} on the delegate. */
@Override
public void moveMediaItem(int currentIndex, int newIndex) {
player.moveMediaItem(currentIndex, newIndex);
}
/** Calls {@link Player#moveMediaItems(int, int, int)} on the delegate. */
@Override
public void moveMediaItems(int fromIndex, int toIndex, int newIndex) {
player.moveMediaItems(fromIndex, toIndex, newIndex);
}
/** Calls {@link Player#removeMediaItem(int)} on the delegate. */
@Override
public void removeMediaItem(int index) {
player.removeMediaItem(index);
}
/** Calls {@link Player#removeMediaItems(int, int)} on the delegate. */
@Override
public void removeMediaItems(int fromIndex, int toIndex) {
player.removeMediaItems(fromIndex, toIndex);
}
/** Calls {@link Player#clearMediaItems()} on the delegate. */
@Override
public void clearMediaItems() {
player.clearMediaItems();
}
/** Calls {@link Player#isCommandAvailable(int)} on the delegate and returns the result. */
@Override
public boolean isCommandAvailable(@Command int command) {
return player.isCommandAvailable(command);
}
/** Calls {@link Player#canAdvertiseSession()} on the delegate and returns the result. */
@Override
public boolean canAdvertiseSession() {
return player.canAdvertiseSession();
}
/** Calls {@link Player#getAvailableCommands()} on the delegate and returns the result. */
@Override
public Commands getAvailableCommands() {
return player.getAvailableCommands();
}
/** Calls {@link Player#prepare()} on the delegate. */
@Override
public void prepare() {
player.prepare();
}
/** Calls {@link Player#getPlaybackState()} on the delegate and returns the result. */
@Override
public int getPlaybackState() {
return player.getPlaybackState();
}
/** Calls {@link Player#getPlaybackSuppressionReason()} on the delegate and returns the result. */
@Override
public int getPlaybackSuppressionReason() {
return player.getPlaybackSuppressionReason();
}
/** Calls {@link Player#isPlaying()} on the delegate and returns the result. */
@Override
public boolean isPlaying() {
return player.isPlaying();
}
/** Calls {@link Player#getPlayerError()} on the delegate and returns the result. */
@Nullable
@Override
public PlaybackException getPlayerError() {
return player.getPlayerError();
}
/** Calls {@link Player#play()} on the delegate. */
@Override
public void play() {
player.play();
}
/** Calls {@link Player#pause()} on the delegate. */
@Override
public void pause() {
player.pause();
}
/** Calls {@link Player#setPlayWhenReady(boolean)} on the delegate. */
@Override
public void setPlayWhenReady(boolean playWhenReady) {
player.setPlayWhenReady(playWhenReady);
}
/** Calls {@link Player#getPlayWhenReady()} on the delegate and returns the result. */
@Override
public boolean getPlayWhenReady() {
return player.getPlayWhenReady();
}
/** Calls {@link Player#setRepeatMode(int)} on the delegate. */
@Override
public void setRepeatMode(@RepeatMode int repeatMode) {
player.setRepeatMode(repeatMode);
}
/** Calls {@link Player#getRepeatMode()} on the delegate and returns the result. */
@Override
public int getRepeatMode() {
return player.getRepeatMode();
}
/** Calls {@link Player#setShuffleModeEnabled(boolean)} on the delegate. */
@Override
public void setShuffleModeEnabled(boolean shuffleModeEnabled) {
player.setShuffleModeEnabled(shuffleModeEnabled);
}
/** Calls {@link Player#getShuffleModeEnabled()} on the delegate and returns the result. */
@Override
public boolean getShuffleModeEnabled() {
return player.getShuffleModeEnabled();
}
/** Calls {@link Player#isLoading()} on the delegate and returns the result. */
@Override
public boolean isLoading() {
return player.isLoading();
}
/** Calls {@link Player#seekToDefaultPosition()} on the delegate. */
@Override
public void seekToDefaultPosition() {
player.seekToDefaultPosition();
}
/** Calls {@link Player#seekToDefaultPosition(int)} on the delegate. */
@Override
public void seekToDefaultPosition(int mediaItemIndex) {
player.seekToDefaultPosition(mediaItemIndex);
}
/** Calls {@link Player#seekTo(long)} on the delegate. */
@Override
public void seekTo(long positionMs) {
player.seekTo(positionMs);
}
/** Calls {@link Player#seekTo(int, long)} on the delegate. */
@Override
public void seekTo(int mediaItemIndex, long positionMs) {
player.seekTo(mediaItemIndex, positionMs);
}
/** Calls {@link Player#getSeekBackIncrement()} on the delegate and returns the result. */
@Override
public long getSeekBackIncrement() {
return player.getSeekBackIncrement();
}
/** Calls {@link Player#seekBack()} on the delegate. */
@Override
public void seekBack() {
player.seekBack();
}
/** Calls {@link Player#getSeekForwardIncrement()} on the delegate and returns the result. */
@Override
public long getSeekForwardIncrement() {
return player.getSeekForwardIncrement();
}
/** Calls {@link Player#seekForward()} on the delegate. */
@Override
public void seekForward() {
player.seekForward();
}
/** Calls {@link Player#hasPrevious()} on the delegate and returns the result. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -262,6 +306,7 @@ public class ForwardingPlayer implements Player {
return player.hasPrevious();
}
/** Calls {@link Player#hasPreviousWindow()} on the delegate and returns the result. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -269,11 +314,13 @@ public class ForwardingPlayer implements Player {
return player.hasPreviousWindow();
}
/** Calls {@link Player#hasPreviousMediaItem()} on the delegate and returns the result. */
@Override
public boolean hasPreviousMediaItem() {
return player.hasPreviousMediaItem();
}
/** Calls {@link Player#previous()} on the delegate. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -281,6 +328,7 @@ public class ForwardingPlayer implements Player {
player.previous();
}
/** Calls {@link Player#seekToPreviousWindow()} on the delegate. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -288,21 +336,25 @@ public class ForwardingPlayer implements Player {
player.seekToPreviousWindow();
}
/** Calls {@link Player#seekToPreviousMediaItem()} on the delegate. */
@Override
public void seekToPreviousMediaItem() {
player.seekToPreviousMediaItem();
}
/** Calls {@link Player#seekToPrevious()} on the delegate. */
@Override
public void seekToPrevious() {
player.seekToPrevious();
}
/** Calls {@link Player#getMaxSeekToPreviousPosition()} on the delegate and returns the result. */
@Override
public long getMaxSeekToPreviousPosition() {
return player.getMaxSeekToPreviousPosition();
}
/** Calls {@link Player#hasNext()} on the delegate and returns the result. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -310,6 +362,7 @@ public class ForwardingPlayer implements Player {
return player.hasNext();
}
/** Calls {@link Player#hasNextWindow()} on the delegate and returns the result. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -317,11 +370,13 @@ public class ForwardingPlayer implements Player {
return player.hasNextWindow();
}
/** Calls {@link Player#hasNextMediaItem()} on the delegate and returns the result. */
@Override
public boolean hasNextMediaItem() {
return player.hasNextMediaItem();
}
/** Calls {@link Player#next()} on the delegate. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -329,6 +384,7 @@ public class ForwardingPlayer implements Player {
player.next();
}
/** Calls {@link Player#seekToNextWindow()} on the delegate. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -336,36 +392,43 @@ public class ForwardingPlayer implements Player {
player.seekToNextWindow();
}
/** Calls {@link Player#seekToNextMediaItem()} on the delegate. */
@Override
public void seekToNextMediaItem() {
player.seekToNextMediaItem();
}
/** Calls {@link Player#seekToNext()} on the delegate. */
@Override
public void seekToNext() {
player.seekToNext();
}
/** Calls {@link Player#setPlaybackParameters(PlaybackParameters)} on the delegate. */
@Override
public void setPlaybackParameters(PlaybackParameters playbackParameters) {
player.setPlaybackParameters(playbackParameters);
}
/** Calls {@link Player#setPlaybackSpeed(float)} on the delegate. */
@Override
public void setPlaybackSpeed(float speed) {
player.setPlaybackSpeed(speed);
}
/** Calls {@link Player#getPlaybackParameters()} on the delegate and returns the result. */
@Override
public PlaybackParameters getPlaybackParameters() {
return player.getPlaybackParameters();
}
/** Calls {@link Player#stop()} on the delegate. */
@Override
public void stop() {
player.stop();
}
/** Calls {@link Player#stop(boolean)} on the delegate. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -373,11 +436,13 @@ public class ForwardingPlayer implements Player {
player.stop(reset);
}
/** Calls {@link Player#release()} on the delegate. */
@Override
public void release() {
player.release();
}
/** Calls {@link Player#getCurrentTrackGroups()} on the delegate and returns the result. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -385,6 +450,7 @@ public class ForwardingPlayer implements Player {
return player.getCurrentTrackGroups();
}
/** Calls {@link Player#getCurrentTrackSelections()} on the delegate and returns the result. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -392,52 +458,62 @@ public class ForwardingPlayer implements Player {
return player.getCurrentTrackSelections();
}
/** Calls {@link Player#getCurrentTracksInfo()} on the delegate and returns the result. */
@Override
public TracksInfo getCurrentTracksInfo() {
return player.getCurrentTracksInfo();
}
/** Calls {@link Player#getTrackSelectionParameters()} on the delegate and returns the result. */
@Override
public TrackSelectionParameters getTrackSelectionParameters() {
return player.getTrackSelectionParameters();
}
/** Calls {@link Player#setTrackSelectionParameters(TrackSelectionParameters)} on the delegate. */
@Override
public void setTrackSelectionParameters(TrackSelectionParameters parameters) {
player.setTrackSelectionParameters(parameters);
}
/** Calls {@link Player#getMediaMetadata()} on the delegate and returns the result. */
@Override
public MediaMetadata getMediaMetadata() {
return player.getMediaMetadata();
}
/** Calls {@link Player#getPlaylistMetadata()} on the delegate and returns the result. */
@Override
public MediaMetadata getPlaylistMetadata() {
return player.getPlaylistMetadata();
}
/** Calls {@link Player#setPlaylistMetadata(MediaMetadata)} on the delegate. */
@Override
public void setPlaylistMetadata(MediaMetadata mediaMetadata) {
player.setPlaylistMetadata(mediaMetadata);
}
/** Calls {@link Player#getCurrentManifest()} on the delegate and returns the result. */
@Nullable
@Override
public Object getCurrentManifest() {
return player.getCurrentManifest();
}
/** Calls {@link Player#getCurrentTimeline()} on the delegate and returns the result. */
@Override
public Timeline getCurrentTimeline() {
return player.getCurrentTimeline();
}
/** Calls {@link Player#getCurrentPeriodIndex()} on the delegate and returns the result. */
@Override
public int getCurrentPeriodIndex() {
return player.getCurrentPeriodIndex();
}
/** Calls {@link Player#getCurrentWindowIndex()} on the delegate and returns the result. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -445,11 +521,13 @@ public class ForwardingPlayer implements Player {
return player.getCurrentWindowIndex();
}
/** Calls {@link Player#getCurrentMediaItemIndex()} on the delegate and returns the result. */
@Override
public int getCurrentMediaItemIndex() {
return player.getCurrentMediaItemIndex();
}
/** Calls {@link Player#getNextWindowIndex()} on the delegate and returns the result. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -457,11 +535,13 @@ public class ForwardingPlayer implements Player {
return player.getNextWindowIndex();
}
/** Calls {@link Player#getNextMediaItemIndex()} on the delegate and returns the result. */
@Override
public int getNextMediaItemIndex() {
return player.getNextMediaItemIndex();
}
/** Calls {@link Player#getPreviousWindowIndex()} on the delegate and returns the result. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -469,52 +549,62 @@ public class ForwardingPlayer implements Player {
return player.getPreviousWindowIndex();
}
/** Calls {@link Player#getPreviousMediaItemIndex()} on the delegate and returns the result. */
@Override
public int getPreviousMediaItemIndex() {
return player.getPreviousMediaItemIndex();
}
/** Calls {@link Player#getCurrentMediaItem()} on the delegate and returns the result. */
@Nullable
@Override
public MediaItem getCurrentMediaItem() {
return player.getCurrentMediaItem();
}
/** Calls {@link Player#getMediaItemCount()} on the delegate and returns the result. */
@Override
public int getMediaItemCount() {
return player.getMediaItemCount();
}
/** Calls {@link Player#getMediaItemAt(int)} on the delegate and returns the result. */
@Override
public MediaItem getMediaItemAt(int index) {
return player.getMediaItemAt(index);
}
/** Calls {@link Player#getDuration()} on the delegate and returns the result. */
@Override
public long getDuration() {
return player.getDuration();
}
/** Calls {@link Player#getCurrentPosition()} on the delegate and returns the result. */
@Override
public long getCurrentPosition() {
return player.getCurrentPosition();
}
/** Calls {@link Player#getBufferedPosition()} on the delegate and returns the result. */
@Override
public long getBufferedPosition() {
return player.getBufferedPosition();
}
/** Calls {@link Player#getBufferedPercentage()} on the delegate and returns the result. */
@Override
public int getBufferedPercentage() {
return player.getBufferedPercentage();
}
/** Calls {@link Player#getTotalBufferedDuration()} on the delegate and returns the result. */
@Override
public long getTotalBufferedDuration() {
return player.getTotalBufferedDuration();
}
/** Calls {@link Player#isCurrentWindowDynamic()} on the delegate and returns the result. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -522,11 +612,13 @@ public class ForwardingPlayer implements Player {
return player.isCurrentWindowDynamic();
}
/** Calls {@link Player#isCurrentMediaItemDynamic()} on the delegate and returns the result. */
@Override
public boolean isCurrentMediaItemDynamic() {
return player.isCurrentMediaItemDynamic();
}
/** Calls {@link Player#isCurrentWindowLive()} on the delegate and returns the result. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -534,16 +626,19 @@ public class ForwardingPlayer implements Player {
return player.isCurrentWindowLive();
}
/** Calls {@link Player#isCurrentMediaItemLive()} on the delegate and returns the result. */
@Override
public boolean isCurrentMediaItemLive() {
return player.isCurrentMediaItemLive();
}
/** Calls {@link Player#getCurrentLiveOffset()} on the delegate and returns the result. */
@Override
public long getCurrentLiveOffset() {
return player.getCurrentLiveOffset();
}
/** Calls {@link Player#isCurrentWindowSeekable()} on the delegate and returns the result. */
@SuppressWarnings("deprecation") // Forwarding to deprecated method
@Deprecated
@Override
@ -551,141 +646,169 @@ public class ForwardingPlayer implements Player {
return player.isCurrentWindowSeekable();
}
/** Calls {@link Player#isCurrentMediaItemSeekable()} on the delegate and returns the result. */
@Override
public boolean isCurrentMediaItemSeekable() {
return player.isCurrentMediaItemSeekable();
}
/** Calls {@link Player#isPlayingAd()} on the delegate and returns the result. */
@Override
public boolean isPlayingAd() {
return player.isPlayingAd();
}
/** Calls {@link Player#getCurrentAdGroupIndex()} on the delegate and returns the result. */
@Override
public int getCurrentAdGroupIndex() {
return player.getCurrentAdGroupIndex();
}
/** Calls {@link Player#getCurrentAdIndexInAdGroup()} on the delegate and returns the result. */
@Override
public int getCurrentAdIndexInAdGroup() {
return player.getCurrentAdIndexInAdGroup();
}
/** Calls {@link Player#getContentDuration()} on the delegate and returns the result. */
@Override
public long getContentDuration() {
return player.getContentDuration();
}
/** Calls {@link Player#getContentPosition()} on the delegate and returns the result. */
@Override
public long getContentPosition() {
return player.getContentPosition();
}
/** Calls {@link Player#getContentBufferedPosition()} on the delegate and returns the result. */
@Override
public long getContentBufferedPosition() {
return player.getContentBufferedPosition();
}
/** Calls {@link Player#getAudioAttributes()} on the delegate and returns the result. */
@Override
public AudioAttributes getAudioAttributes() {
return player.getAudioAttributes();
}
/** Calls {@link Player#setVolume(float)} on the delegate. */
@Override
public void setVolume(float volume) {
player.setVolume(volume);
}
/** Calls {@link Player#getVolume()} on the delegate and returns the result. */
@Override
public float getVolume() {
return player.getVolume();
}
/** Calls {@link Player#getVideoSize()} on the delegate and returns the result. */
@Override
public VideoSize getVideoSize() {
return player.getVideoSize();
}
/** Calls {@link Player#clearVideoSurface()} on the delegate. */
@Override
public void clearVideoSurface() {
player.clearVideoSurface();
}
/** Calls {@link Player#clearVideoSurface(Surface)} on the delegate. */
@Override
public void clearVideoSurface(@Nullable Surface surface) {
player.clearVideoSurface(surface);
}
/** Calls {@link Player#setVideoSurface(Surface)} on the delegate. */
@Override
public void setVideoSurface(@Nullable Surface surface) {
player.setVideoSurface(surface);
}
/** Calls {@link Player#setVideoSurfaceHolder(SurfaceHolder)} on the delegate. */
@Override
public void setVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder) {
player.setVideoSurfaceHolder(surfaceHolder);
}
/** Calls {@link Player#clearVideoSurfaceHolder(SurfaceHolder)} on the delegate. */
@Override
public void clearVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder) {
player.clearVideoSurfaceHolder(surfaceHolder);
}
/** Calls {@link Player#setVideoSurfaceView(SurfaceView)} on the delegate. */
@Override
public void setVideoSurfaceView(@Nullable SurfaceView surfaceView) {
player.setVideoSurfaceView(surfaceView);
}
/** Calls {@link Player#clearVideoSurfaceView(SurfaceView)} on the delegate. */
@Override
public void clearVideoSurfaceView(@Nullable SurfaceView surfaceView) {
player.clearVideoSurfaceView(surfaceView);
}
/** Calls {@link Player#setVideoTextureView(TextureView)} on the delegate. */
@Override
public void setVideoTextureView(@Nullable TextureView textureView) {
player.setVideoTextureView(textureView);
}
/** Calls {@link Player#clearVideoTextureView(TextureView)} on the delegate. */
@Override
public void clearVideoTextureView(@Nullable TextureView textureView) {
player.clearVideoTextureView(textureView);
}
/** Calls {@link Player#getCurrentCues()} on the delegate and returns the result. */
@Override
public List<Cue> getCurrentCues() {
return player.getCurrentCues();
}
/** Calls {@link Player#getDeviceInfo()} on the delegate and returns the result. */
@Override
public DeviceInfo getDeviceInfo() {
return player.getDeviceInfo();
}
/** Calls {@link Player#getDeviceVolume()} on the delegate and returns the result. */
@Override
public int getDeviceVolume() {
return player.getDeviceVolume();
}
/** Calls {@link Player#isDeviceMuted()} on the delegate and returns the result. */
@Override
public boolean isDeviceMuted() {
return player.isDeviceMuted();
}
/** Calls {@link Player#setDeviceVolume(int)} on the delegate. */
@Override
public void setDeviceVolume(int volume) {
player.setDeviceVolume(volume);
}
/** Calls {@link Player#increaseDeviceVolume()} on the delegate. */
@Override
public void increaseDeviceVolume() {
player.increaseDeviceVolume();
}
/** Calls {@link Player#decreaseDeviceVolume()} on the delegate. */
@Override
public void decreaseDeviceVolume() {
player.decreaseDeviceVolume();
}
/** Calls {@link Player#setDeviceMuted(boolean)} on the delegate. */
@Override
public void setDeviceMuted(boolean muted) {
player.setDeviceMuted(muted);