Merge pull request #597 from fynngodau/related-items

Rename getRelatedStreams to getRelatedItems and change return type

Author: XiangRongLin

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;
     }
 

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;
     }
 

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;
     }
 

extractor/src/main/java/org/schabi/newpipe/extractor/services/peertube/extractors/PeertubeStreamExtractor.java

@@ -264,15 +264,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)) {
@@ -312,7 +312,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");

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())

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) {

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,24 @@ 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;
+
+    /**
+     * @deprecated Use {@link #getRelatedItems()}. May be removed in a future version.
+     * @return The result of {@link #getRelatedItems()} if it is a
+     *         StreamInfoItemsCollector, null otherwise
+     * @throws IOException
+     * @throws ExtractionException
+     */
+    @Deprecated
+    @Nullable
+    public StreamInfoItemsCollector getRelatedStreams() throws IOException, ExtractionException {
+        InfoItemsCollector<?, ?> collector = getRelatedItems();
+        if (collector instanceof StreamInfoItemsCollector) {
+            return (StreamInfoItemsCollector) collector;
+        } else return null;
+    }
 
     /**
      * Should return a list of Frameset object that contains preview of stream frames

extractor/src/main/java/org/schabi/newpipe/extractor/stream/StreamInfo.java

@@ -335,7 +335,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;
     }
@@ -371,7 +371,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<>();
@@ -603,12 +603,28 @@ public void setHlsUrl(String hlsUrl) {
         this.hlsUrl = hlsUrl;
     }
 
+    public List<InfoItem> getRelatedItems() {
+        return relatedItems;
+    }
+
+    /**
+     * @deprecated Use {@link #getRelatedItems()}
+     */
+    @Deprecated
     public List<InfoItem> getRelatedStreams() {
-        return relatedStreams;
+        return getRelatedItems();
     }
 
-    public void setRelatedStreams(List<InfoItem> relatedStreams) {
-        this.relatedStreams = relatedStreams;
+    public void setRelatedItems(List<InfoItem> relatedItems) {
+        this.relatedItems = relatedItems;
+    }
+
+    /**
+     * @deprecated Use {@link #setRelatedItems(List)}
+     */
+    @Deprecated
+    public void setRelatedStreams(List<InfoItem> relatedItems) {
+        setRelatedItems(relatedItems);
     }
 
     public long getStartPosition() {

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());
 
@@ -41,4 +41,12 @@ public static List<InfoItem> getRelatedVideosOrLogError(StreamInfo info, StreamE
         }
     }
 
+    /**
+     * @deprecated Use {@link #getRelatedItemsOrLogError(StreamInfo, StreamExtractor)}
+     */
+    @Deprecated
+    public static List<InfoItem> getRelatedVideosOrLogError(StreamInfo info, StreamExtractor extractor) {
+        return getRelatedItemsOrLogError(info, extractor);
+    }
+
 }

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;