Generify related streams calls and rename method

fynngodau · fynngodau · commit 14f6f1b7c3d4 · 2021-03-31T20:24:40.000+02:00
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/extractors/BandcampStreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/extractors/BandcampStreamExtractor.java
@@ -245,7 +245,7 @@ public StreamType getStreamType() {
     }
 
     @Override
-    public StreamInfoItemsCollector getRelatedStreams() {
+    public StreamInfoItemsCollector getRelatedItems() {
         return null;
     }
 
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCLiveStreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCLiveStreamExtractor.java
@@ -240,7 +240,7 @@ public StreamType getStreamType() throws ParsingException {
 
     @Nullable
     @Override
-    public StreamInfoItemsCollector getRelatedStreams() {
+    public StreamInfoItemsCollector getRelatedItems() {
         return null;
     }
 
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCStreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCStreamExtractor.java
@@ -219,7 +219,7 @@ public StreamType getStreamType() {
 
     @Nullable
     @Override
-    public StreamInfoItemsCollector getRelatedStreams() {
+    public StreamInfoItemsCollector getRelatedItems() {
         return null;
     }
 
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/peertube/extractors/PeertubeStreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/peertube/extractors/PeertubeStreamExtractor.java
@@ -263,15 +263,15 @@ public StreamType getStreamType() {
 
     @Nullable
     @Override
-    public StreamInfoItemsCollector getRelatedStreams() throws IOException, ExtractionException {
+    public StreamInfoItemsCollector getRelatedItems() throws IOException, ExtractionException {
         final List<String> tags = getTags();
         final String apiUrl;
         if (tags.isEmpty()) {
             apiUrl = baseUrl + "/api/v1/accounts/" + JsonUtils.getString(json, "account.name")
                     + "@" + JsonUtils.getString(json, "account.host") +
                     "/videos?start=0&count=8";
         } else {
-            apiUrl = getRelatedStreamsUrl(tags);
+            apiUrl = getRelatedItemsUrl(tags);
         }
 
         if (Utils.isBlank(apiUrl)) {
@@ -311,7 +311,7 @@ public List<MetaInfo> getMetaInfo() {
         return Collections.emptyList();
     }
 
-    private String getRelatedStreamsUrl(final List<String> tags) throws UnsupportedEncodingException {
+    private String getRelatedItemsUrl(final List<String> tags) throws UnsupportedEncodingException {
         final String url = baseUrl + PeertubeSearchQueryHandlerFactory.SEARCH_ENDPOINT;
         final StringBuilder params = new StringBuilder();
         params.append("start=0&count=8&sort=-createdAt");
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/soundcloud/extractors/SoundcloudStreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/soundcloud/extractors/SoundcloudStreamExtractor.java
@@ -353,7 +353,7 @@ public StreamType getStreamType() {
 
     @Nullable
     @Override
-    public StreamInfoItemsCollector getRelatedStreams() throws IOException, ExtractionException {
+    public StreamInfoItemsCollector getRelatedItems() throws IOException, ExtractionException {
         final StreamInfoItemsCollector collector = new StreamInfoItemsCollector(getServiceId());
 
         final String apiUrl = "https://api-v2.soundcloud.com/tracks/" + urlEncode(getId())
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeStreamExtractor.java
@@ -643,7 +643,7 @@ private StreamInfoItemExtractor getNextStream() throws ExtractionException {
 
     @Nullable
     @Override
-    public StreamInfoItemsCollector getRelatedStreams() throws ExtractionException {
+    public StreamInfoItemsCollector getRelatedItems() throws ExtractionException {
         assertPageFetched();
 
         if (getAgeLimit() != NO_AGE_LIMIT) {
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamExtractor.java
@@ -20,6 +20,9 @@
  * along with NewPipe.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+import org.schabi.newpipe.extractor.InfoItem;
+import org.schabi.newpipe.extractor.InfoItemsCollector;
+import org.schabi.newpipe.extractor.InfoItemExtractor;
 import org.schabi.newpipe.extractor.Extractor;
 import org.schabi.newpipe.extractor.MediaFormat;
 import org.schabi.newpipe.extractor.MetaInfo;
@@ -331,7 +334,8 @@ public StreamExtractor(StreamingService service, LinkHandler linkHandler) {
      * @throws ExtractionException
      */
     @Nullable
-    public abstract StreamInfoItemsCollector getRelatedStreams() throws IOException, ExtractionException;
+    public abstract InfoItemsCollector<? extends InfoItem, ? extends InfoItemExtractor>
+    getRelatedItems() throws IOException, ExtractionException;
 
     /**
      * Should return a list of Frameset object that contains preview of stream frames
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamInfo.java b/extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamInfo.java
@@ -334,7 +334,7 @@ private static StreamInfo extractOptionalData(StreamInfo streamInfo, StreamExtra
             streamInfo.addError(e);
         }
 
-        streamInfo.setRelatedStreams(ExtractorHelper.getRelatedVideosOrLogError(streamInfo, extractor));
+        streamInfo.setRelatedItems(ExtractorHelper.getRelatedItemsOrLogError(streamInfo, extractor));
 
         return streamInfo;
     }
@@ -370,7 +370,7 @@ private static StreamInfo extractOptionalData(StreamInfo streamInfo, StreamExtra
 
 
     private String hlsUrl = "";
-    private List<InfoItem> relatedStreams = new ArrayList<>();
+    private List<InfoItem> relatedItems = new ArrayList<>();
 
     private long startPosition = 0;
     private List<SubtitlesStream> subtitles = new ArrayList<>();
@@ -602,12 +602,12 @@ public void setHlsUrl(String hlsUrl) {
         this.hlsUrl = hlsUrl;
     }
 
-    public List<InfoItem> getRelatedStreams() {
-        return relatedStreams;
+    public List<InfoItem> getRelatedItems() {
+        return relatedItems;
     }
 
-    public void setRelatedStreams(List<InfoItem> relatedStreams) {
-        this.relatedStreams = relatedStreams;
+    public void setRelatedItems(List<InfoItem> relatedItems) {
+        this.relatedItems = relatedItems;
     }
 
     public long getStartPosition() {
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/utils/ExtractorHelper.java b/extractor/src/main/java/org/schabi/newpipe/extractor/utils/ExtractorHelper.java
@@ -27,9 +27,9 @@ public static <T extends InfoItem> InfoItemsPage<T> getItemsPageOrLogError(Info
     }
 
 
-    public static List<InfoItem> getRelatedVideosOrLogError(StreamInfo info, StreamExtractor extractor) {
+    public static List<InfoItem> getRelatedItemsOrLogError(StreamInfo info, StreamExtractor extractor) {
         try {
-            InfoItemsCollector<? extends InfoItem, ?> collector = extractor.getRelatedStreams();
+            InfoItemsCollector<? extends InfoItem, ?> collector = extractor.getRelatedItems();
             if (collector == null) return Collections.emptyList();
             info.addAllErrors(collector.getErrors());
 
diff --git a/extractor/src/test/java/org/schabi/newpipe/extractor/services/BaseStreamExtractorTest.java b/extractor/src/test/java/org/schabi/newpipe/extractor/services/BaseStreamExtractorTest.java
@@ -17,7 +17,7 @@ public interface BaseStreamExtractorTest extends BaseExtractorTest {
     void testTextualUploadDate() throws Exception;
     void testLikeCount() throws Exception;
     void testDislikeCount() throws Exception;
-    void testRelatedStreams() throws Exception;
+    void testRelatedItems() throws Exception;
     void testAgeLimit() throws Exception;
     void testErrorMessage() throws Exception;
     void testAudioStreams() throws Exception;
diff --git a/extractor/src/test/java/org/schabi/newpipe/extractor/services/DefaultStreamExtractorTest.java b/extractor/src/test/java/org/schabi/newpipe/extractor/services/DefaultStreamExtractorTest.java
@@ -1,14 +1,14 @@
 package org.schabi.newpipe.extractor.services;
 
 import org.junit.Test;
+import org.schabi.newpipe.extractor.InfoItemsCollector;
 import org.schabi.newpipe.extractor.MediaFormat;
 import org.schabi.newpipe.extractor.MetaInfo;
 import org.schabi.newpipe.extractor.localization.DateWrapper;
 import org.schabi.newpipe.extractor.stream.AudioStream;
 import org.schabi.newpipe.extractor.stream.Description;
 import org.schabi.newpipe.extractor.stream.Frameset;
 import org.schabi.newpipe.extractor.stream.StreamExtractor;
-import org.schabi.newpipe.extractor.stream.StreamInfoItemsCollector;
 import org.schabi.newpipe.extractor.stream.StreamType;
 import org.schabi.newpipe.extractor.stream.SubtitlesStream;
 import org.schabi.newpipe.extractor.stream.VideoStream;
@@ -57,7 +57,7 @@ public abstract class DefaultStreamExtractorTest extends DefaultExtractorTest<St
     @Nullable public abstract String expectedTextualUploadDate();
     public abstract long expectedLikeCountAtLeast(); // return -1 if ratings are disabled
     public abstract long expectedDislikeCountAtLeast(); // return -1 if ratings are disabled
-    public boolean expectedHasRelatedStreams() { return true; } // default: there are related videos
+    public boolean expectedHasRelatedItems() { return true; } // default: there are related videos
     public int expectedAgeLimit() { return StreamExtractor.NO_AGE_LIMIT; } // default: no limit
     @Nullable public String expectedErrorMessage() { return null; } // default: no error message
     public boolean expectedHasVideoStreams() { return true; } // default: there are video streams
@@ -223,10 +223,10 @@ public void testDislikeCount() throws Exception {
 
     @Test
     @Override
-    public void testRelatedStreams() throws Exception {
-        final StreamInfoItemsCollector relatedStreams = extractor().getRelatedStreams();
+    public void testRelatedItems() throws Exception {
+        final InfoItemsCollector<?, ?> relatedStreams = extractor().getRelatedItems();
 
-        if (expectedHasRelatedStreams()) {
+        if (expectedHasRelatedItems()) {
             assertNotNull(relatedStreams);
             defaultTestListOfItems(extractor().getService(), relatedStreams.getItems(),
                     relatedStreams.getErrors());
diff --git a/extractor/src/test/java/org/schabi/newpipe/extractor/services/bandcamp/BandcampRadioStreamExtractorTest.java b/extractor/src/test/java/org/schabi/newpipe/extractor/services/bandcamp/BandcampRadioStreamExtractorTest.java
@@ -50,7 +50,7 @@ public void testGettingCorrectStreamExtractor() throws ExtractionException {
     @Override public boolean expectedHasVideoStreams() { return false; }
     @Override public boolean expectedHasSubtitles() { return false; }
     @Override public boolean expectedHasFrames() { return false; }
-    @Override public boolean expectedHasRelatedStreams() { return false; }
+    @Override public boolean expectedHasRelatedItems() { return false; }
     @Override public StreamType expectedStreamType() { return StreamType.AUDIO_STREAM; }
     @Override public StreamingService expectedService() { return Bandcamp; }
     @Override public String expectedUploaderName() { return "Andrew Jervis"; }
diff --git a/extractor/src/test/java/org/schabi/newpipe/extractor/services/bandcamp/BandcampStreamExtractorTest.java b/extractor/src/test/java/org/schabi/newpipe/extractor/services/bandcamp/BandcampStreamExtractorTest.java
@@ -125,7 +125,7 @@ public boolean expectedHasVideoStreams() {
     }
 
     @Override
-    public boolean expectedHasRelatedStreams() {
+    public boolean expectedHasRelatedItems() {
         return false;
     }
 
diff --git a/extractor/src/test/java/org/schabi/newpipe/extractor/services/media_ccc/MediaCCCStreamExtractorTest.java b/extractor/src/test/java/org/schabi/newpipe/extractor/services/media_ccc/MediaCCCStreamExtractorTest.java
@@ -54,7 +54,7 @@ public static void setUp() throws Exception {
         @Nullable @Override public String expectedTextualUploadDate() { return "2018-05-11T02:00:00.000+02:00"; }
         @Override public long expectedLikeCountAtLeast() { return -1; }
         @Override public long expectedDislikeCountAtLeast() { return -1; }
-        @Override public boolean expectedHasRelatedStreams() { return false; }
+        @Override public boolean expectedHasRelatedItems() { return false; }
         @Override public boolean expectedHasSubtitles() { return false; }
         @Override public boolean expectedHasFrames() { return false; }
         @Override public List<String> expectedTags() { return Arrays.asList("gpn18", "105"); }
@@ -125,7 +125,7 @@ public static void setUp() throws Exception {
         @Nullable @Override public String expectedTextualUploadDate() { return "2020-01-11T01:00:00.000+01:00"; }
         @Override public long expectedLikeCountAtLeast() { return -1; }
         @Override public long expectedDislikeCountAtLeast() { return -1; }
-        @Override public boolean expectedHasRelatedStreams() { return false; }
+        @Override public boolean expectedHasRelatedItems() { return false; }
         @Override public boolean expectedHasSubtitles() { return false; }
         @Override public boolean expectedHasFrames() { return false; }
         @Override public List<String> expectedTags() { return Arrays.asList("36c3", "10565", "2019", "Security", "Main"); }
diff --git a/extractor/src/test/java/org/schabi/newpipe/extractor/services/soundcloud/SoundcloudStreamExtractorTest.java b/extractor/src/test/java/org/schabi/newpipe/extractor/services/soundcloud/SoundcloudStreamExtractorTest.java
@@ -70,7 +70,7 @@ public static void setUp() throws Exception {
         @Override public boolean expectedHasSubtitles() { return false; }
         @Override public boolean expectedHasFrames() { return false; }
         @Override public int expectedStreamSegmentsCount() { return 0; }
-        @Override public boolean expectedHasRelatedStreams() { return false; }
+        @Override public boolean expectedHasRelatedItems() { return false; }
         @Override public String expectedLicence() { return "all-rights-reserved"; }
         @Override public String expectedCategory() { return "Pop"; }
     }
@@ -115,7 +115,7 @@ public static void setUp() throws Exception {
         @Override public long expectedDislikeCountAtLeast() { return -1; }
         @Override public boolean expectedHasAudioStreams() { return false; }
         @Override public boolean expectedHasVideoStreams() { return false; }
-        @Override public boolean expectedHasRelatedStreams() { return false; }
+        @Override public boolean expectedHasRelatedItems() { return false; }
         @Override public boolean expectedHasSubtitles() { return false; }
         @Override public boolean expectedHasFrames() { return false; }
         @Override public int expectedStreamSegmentsCount() { return 0; }
diff --git a/extractor/src/test/java/org/schabi/newpipe/extractor/services/youtube/stream/YoutubeStreamExtractorAgeRestrictedTest.java b/extractor/src/test/java/org/schabi/newpipe/extractor/services/youtube/stream/YoutubeStreamExtractorAgeRestrictedTest.java
@@ -50,7 +50,7 @@ public static void setUp() throws Exception {
     @Nullable @Override public String expectedTextualUploadDate() { return "2017-01-25"; }
     @Override public long expectedLikeCountAtLeast() { return 149000; }
     @Override public long expectedDislikeCountAtLeast() { return 38000; }
-    @Override public boolean expectedHasRelatedStreams() { return false; } // no related videos (!)
+    @Override public boolean expectedHasRelatedItems() { return false; } // no related videos (!)
     @Override public int expectedAgeLimit() { return 18; }
     @Nullable @Override public String expectedErrorMessage() { return "Sign in to confirm your age"; }
     @Override public boolean expectedHasSubtitles() { return false; }

Original file line number	Diff line number	Diff line change
`@@ -245,7 +245,7 @@ public StreamType getStreamType() {`
`245`	`245`	`}`
`246`	`246`
`247`	`247`	`@Override`
`248`		`- public StreamInfoItemsCollector getRelatedStreams() {`
	`248`	`+ public StreamInfoItemsCollector getRelatedItems() {`
`249`	`249`	`return null;`
`250`	`250`	`}`
`251`	`251`
Original file line number	Diff line number	Diff line change
`@@ -240,7 +240,7 @@ public StreamType getStreamType() throws ParsingException {`
`240`	`240`
`241`	`241`	`@Nullable`
`242`	`242`	`@Override`
`243`		`- public StreamInfoItemsCollector getRelatedStreams() {`
	`243`	`+ public StreamInfoItemsCollector getRelatedItems() {`
`244`	`244`	`return null;`
`245`	`245`	`}`
`246`	`246`
Original file line number	Diff line number	Diff line change
`@@ -219,7 +219,7 @@ public StreamType getStreamType() {`
`219`	`219`
`220`	`220`	`@Nullable`
`221`	`221`	`@Override`
`222`		`- public StreamInfoItemsCollector getRelatedStreams() {`
	`222`	`+ public StreamInfoItemsCollector getRelatedItems() {`
`223`	`223`	`return null;`
`224`	`224`	`}`
`225`	`225`
Original file line number	Diff line number	Diff line change
`@@ -334,7 +334,7 @@ private static StreamInfo extractOptionalData(StreamInfo streamInfo, StreamExtra`
`334`	`334`	`streamInfo.addError(e);`
`335`	`335`	`}`
`336`	`336`
`337`		`- streamInfo.setRelatedStreams(ExtractorHelper.getRelatedVideosOrLogError(streamInfo, extractor));`
	`337`	`+ streamInfo.setRelatedItems(ExtractorHelper.getRelatedItemsOrLogError(streamInfo, extractor));`
`338`	`338`
`339`	`339`	`return streamInfo;`
`340`	`340`	`}`
`@@ -370,7 +370,7 @@ private static StreamInfo extractOptionalData(StreamInfo streamInfo, StreamExtra`
`370`	`370`
`371`	`371`
`372`	`372`	`private String hlsUrl = "";`
`373`		`- private List<InfoItem> relatedStreams = new ArrayList<>();`
	`373`	`+ private List<InfoItem> relatedItems = new ArrayList<>();`
`374`	`374`
`375`	`375`	`private long startPosition = 0;`
`376`	`376`	`private List<SubtitlesStream> subtitles = new ArrayList<>();`
`@@ -602,12 +602,12 @@ public void setHlsUrl(String hlsUrl) {`
`602`	`602`	`this.hlsUrl = hlsUrl;`
`603`	`603`	`}`
`604`	`604`
`605`		`- public List<InfoItem> getRelatedStreams() {`
`606`		`- return relatedStreams;`
	`605`	`+ public List<InfoItem> getRelatedItems() {`
	`606`	`+ return relatedItems;`
`607`	`607`	`}`
`608`	`608`
`609`		`- public void setRelatedStreams(List<InfoItem> relatedStreams) {`
`610`		`- this.relatedStreams = relatedStreams;`
	`609`	`+ public void setRelatedItems(List<InfoItem> relatedItems) {`
	`610`	`+ this.relatedItems = relatedItems;`
`611`	`611`	`}`
`612`	`612`
`613`	`613`	`public long getStartPosition() {`
Original file line number	Diff line number	Diff line change
`@@ -27,9 +27,9 @@ public static <T extends InfoItem> InfoItemsPage<T> getItemsPageOrLogError(Info`
`27`	`27`	`}`
`28`	`28`
`29`	`29`
`30`		`- public static List<InfoItem> getRelatedVideosOrLogError(StreamInfo info, StreamExtractor extractor) {`
	`30`	`+ public static List<InfoItem> getRelatedItemsOrLogError(StreamInfo info, StreamExtractor extractor) {`
`31`	`31`	`try {`
`32`		`- InfoItemsCollector<? extends InfoItem, ?> collector = extractor.getRelatedStreams();`
	`32`	`+ InfoItemsCollector<? extends InfoItem, ?> collector = extractor.getRelatedItems();`
`33`	`33`	`if (collector == null) return Collections.emptyList();`
`34`	`34`	`info.addAllErrors(collector.getErrors());`
`35`	`35`