From 6977c8f455f3a608e1c3c0c9cd53c17d374e668a Mon Sep 17 00:00:00 2001 From: olly Date: Mon, 16 May 2016 08:40:14 -0700 Subject: [PATCH] Bit of naming/documentation cleanup. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=122423250 --- .../android/exoplayer/ExoPlayerImplInternal.java | 2 +- .../com/google/android/exoplayer/TrackRenderer.java | 12 ++++++------ .../com/google/android/exoplayer/TrackStream.java | 3 +-- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/library/src/main/java/com/google/android/exoplayer/ExoPlayerImplInternal.java b/library/src/main/java/com/google/android/exoplayer/ExoPlayerImplInternal.java index 247d19d304..0342733a11 100644 --- a/library/src/main/java/com/google/android/exoplayer/ExoPlayerImplInternal.java +++ b/library/src/main/java/com/google/android/exoplayer/ExoPlayerImplInternal.java @@ -376,7 +376,7 @@ import java.util.concurrent.atomic.AtomicInteger; // preventing the renderer from making progress, if such an error exists. boolean rendererReadyOrEnded = isReadyOrEnded(renderer); if (!rendererReadyOrEnded) { - renderer.maybeThrowError(); + renderer.maybeThrowStreamError(); } allRenderersReadyOrEnded = allRenderersReadyOrEnded && rendererReadyOrEnded; } diff --git a/library/src/main/java/com/google/android/exoplayer/TrackRenderer.java b/library/src/main/java/com/google/android/exoplayer/TrackRenderer.java index 86cdf216bc..b592096021 100644 --- a/library/src/main/java/com/google/android/exoplayer/TrackRenderer.java +++ b/library/src/main/java/com/google/android/exoplayer/TrackRenderer.java @@ -165,16 +165,16 @@ public abstract class TrackRenderer implements ExoPlayerComponent { * Enable the renderer to consume from the specified {@link TrackStream}. * * @param formats The enabled formats. - * @param trackStream The track stream from which the renderer should consume. + * @param stream The track stream from which the renderer should consume. * @param positionUs The player's current position. * @param joining Whether this renderer is being enabled to join an ongoing playback. * @throws ExoPlaybackException If an error occurs. */ - /* package */ final void enable(Format[] formats, TrackStream trackStream, long positionUs, + /* package */ final void enable(Format[] formats, TrackStream stream, long positionUs, boolean joining) throws ExoPlaybackException { Assertions.checkState(state == STATE_DISABLED); state = STATE_ENABLED; - stream = trackStream; + this.stream = stream; onEnabled(formats, joining); reset(positionUs); } @@ -261,8 +261,8 @@ public abstract class TrackRenderer implements ExoPlayerComponent { // Methods to be called by subclasses. /** - * Throws an error that's preventing the renderer from making progress or buffering more data at - * this point in time. + * Throws an error that's preventing the renderer from reading from its {@link TrackStream}. Does + * nothing if no such error exists. *

* This method may be called when the renderer is in the following states: * {@link #STATE_ENABLED}. @@ -270,7 +270,7 @@ public abstract class TrackRenderer implements ExoPlayerComponent { * @throws IOException An error that's preventing the renderer from making progress or buffering * more data. */ - protected final void maybeThrowError() throws IOException { + protected final void maybeThrowStreamError() throws IOException { stream.maybeThrowError(); } diff --git a/library/src/main/java/com/google/android/exoplayer/TrackStream.java b/library/src/main/java/com/google/android/exoplayer/TrackStream.java index a09e1abe41..4224169f67 100644 --- a/library/src/main/java/com/google/android/exoplayer/TrackStream.java +++ b/library/src/main/java/com/google/android/exoplayer/TrackStream.java @@ -46,8 +46,7 @@ public interface TrackStream { boolean isReady(); /** - * If there's an underlying error preventing data from being read, it's thrown by this method. - * If not, this method does nothing. + * Throws an error that's preventing data from being read. Does nothing if no such error exists. * * @throws IOException The underlying error. */