loliball/media
1
0
Fork 0
mirror of https://github.com/androidx/media.git synced 2025-04-30 06:46:50 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add PreloadException with initial subset of error codes

Browse Source 
As the first version, the error codes only include the miscellaneous and IO errors, but are likely to be extended.

PiperOrigin-RevId: 648466385
This commit is contained in:
tianyifeng 2024-07-01 13:21:37 -07:00 committed by Copybara-Service
parent 711d18de03
commit 7fb6eee920
2 changed files with 202 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
libraries/exoplayer/src/main/java/androidx/media3/exoplayer/source/preload/PreloadException.java Normal file
View File

@ -0,0 +1,72 @@
/*
* Copyright 2024 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.media3.exoplayer.source.preload;
import androidx.annotation.Nullable;
import androidx.media3.common.MediaItem;
import androidx.media3.common.util.UnstableApi;
import java.util.Objects;
/** Thrown when a non-recoverable preload failure occurs. */
@UnstableApi
public final class PreloadException extends Exception {
/** The {@link MediaItem} that this instance is associated with. */
public final MediaItem mediaItem;
/**
* Creates an instance.
*
* @param mediaItem The {@link MediaItem} that this instance is associated with.
* @param message See {@link #getMessage()}.
* @param cause See {@link #getCause()}.
*/
public PreloadException(
MediaItem mediaItem, @Nullable String message, @Nullable Throwable cause) {
super(message, cause);
this.mediaItem = mediaItem;
}
/**
* Returns whether the error data associated to this exception equals the error data associated to
* {@code other}.
*
* <p>Note that this method does not compare the exceptions' stack traces.
*/
public boolean errorInfoEquals(@Nullable PreloadException other) {
if (this == other) {
return true;
}
if (other == null || getClass() != other.getClass()) {
return false;
}
@Nullable Throwable thisCause = getCause();
@Nullable Throwable thatCause = other.getCause();
if (thisCause != null && thatCause != null) {
if (!Objects.equals(thisCause.getMessage(), thatCause.getMessage())) {
return false;
}
if (!Objects.equals(thisCause.getClass(), thatCause.getClass())) {
return false;
}
} else if (thisCause != null || thatCause != null) {
return false;
}
return Objects.equals(mediaItem, other.mediaItem)
&& Objects.equals(getMessage(), other.getMessage());
}
}

130
libraries/exoplayer/src/test/java/androidx/media3/exoplayer/source/preload/PreloadExceptionTest.java Normal file
View File

@ -0,0 +1,130 @@
/*
* Copyright 2024 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.media3.exoplayer.source.preload;
import static com.google.common.truth.Truth.assertThat;
import androidx.media3.common.MediaItem;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import java.io.IOException;
import java.util.concurrent.TimeoutException;
import org.junit.Test;
import org.junit.runner.RunWith;
/** Unit test for {@link PreloadException}. */
@RunWith(AndroidJUnit4.class)
public final class PreloadExceptionTest {
@Test
public void errorInfoEquals_withSameInstance_shouldReturnTrue() {
PreloadException preloadException =
new PreloadException(
new MediaItem.Builder().setMediaId("testId").build(),
"Preload error",
new IOException("cause message"));
assertThat(preloadException.errorInfoEquals(preloadException)).isTrue();
}
@Test
public void errorInfoEquals_withSameInfo_shouldReturnTrue() {
MediaItem mediaItem = new MediaItem.Builder().setMediaId("testId").build();
IOException exception1 = new IOException("cause message");
PreloadException preloadException1 =
new PreloadException(mediaItem, "Preload error", exception1);
IOException exception2 = new IOException("cause message");
PreloadException preloadException2 =
new PreloadException(mediaItem, "Preload error", exception2);
assertThat(preloadException1.errorInfoEquals(preloadException2)).isTrue();
}
@Test
public void errorInfoEquals_withNull_shouldReturnFalse() {
PreloadException preloadException =
new PreloadException(
new MediaItem.Builder().setMediaId("testId").build(),
"Preload error",
new Exception("Cause message"));
assertThat(preloadException.errorInfoEquals(null)).isFalse();
}
@Test
public void errorInfoEquals_withNonEqualCauseMessage_shouldReturnFalse() {
MediaItem mediaItem = new MediaItem.Builder().setMediaId("testId").build();
IOException exception1 = new IOException("cause message");
PreloadException preloadException1 =
new PreloadException(mediaItem, "Preload error", exception1);
IOException exception2 = new IOException("other cause message");
PreloadException preloadException2 =
new PreloadException(mediaItem, "Preload error", exception2);
assertThat(preloadException1.errorInfoEquals(preloadException2)).isFalse();
}
@Test
public void errorInfoEquals_withDifferentCauseExceptionType_shouldReturnFalse() {
MediaItem mediaItem = new MediaItem.Builder().setMediaId("testId").build();
IOException exception1 = new IOException("cause message");
PreloadException preloadException1 =
new PreloadException(mediaItem, "Preload error", exception1);
TimeoutException exception2 = new TimeoutException("cause message");
PreloadException preloadException2 =
new PreloadException(mediaItem, "Preload error", exception2);
assertThat(preloadException1.errorInfoEquals(preloadException2)).isFalse();
}
@Test
public void errorInfoEquals_withNullCause_shouldReturnFalse() {
MediaItem mediaItem = new MediaItem.Builder().setMediaId("testId").build();
IOException exception1 = new IOException("cause message");
PreloadException preloadException1 =
new PreloadException(mediaItem, "Preload error", exception1);
PreloadException preloadException2 =
new PreloadException(mediaItem, "Preload error", /* cause= */ null);
assertThat(preloadException1.errorInfoEquals(preloadException2)).isFalse();
}
@Test
public void errorInfoEquals_withNonEqualMediaItem_shouldReturnFalse() {
PreloadException preloadException1 =
new PreloadException(
new MediaItem.Builder().setMediaId("testId1").build(),
"Preload error",
new IOException("cause message"));
PreloadException preloadException2 =
new PreloadException(
new MediaItem.Builder().setMediaId("testId2").build(),
"Preload error",
new IOException("cause message"));
assertThat(preloadException1.errorInfoEquals(preloadException2)).isFalse();
}
@Test
public void errorInfoEquals_withNonEqualMessage_shouldReturnFalse() {
MediaItem mediaItem = new MediaItem.Builder().setMediaId("testId").build();
PreloadException preloadException1 =
new PreloadException(mediaItem, "Preload error", new IOException("cause message"));
PreloadException preloadException2 =
new PreloadException(mediaItem, "Other preload error", new IOException("cause message"));
assertThat(preloadException1.errorInfoEquals(preloadException2)).isFalse();
}
}