switch from string to Description object

ChunkyProgrammer · ChunkyProgrammer · commit 81f29116bad1 · 2023-05-11T00:36:57.000-04:00
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/playlist/PlaylistExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/playlist/PlaylistExtractor.java
@@ -4,6 +4,7 @@
 import org.schabi.newpipe.extractor.StreamingService;
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler;
+import org.schabi.newpipe.extractor.stream.Description;
 import org.schabi.newpipe.extractor.stream.StreamInfoItem;
 
 import javax.annotation.Nonnull;
@@ -21,7 +22,7 @@ public PlaylistExtractor(final StreamingService service, final ListLinkHandler l
 
     public abstract long getStreamCount() throws ParsingException;
 
-    public abstract String getDescription() throws ParsingException;
+    public abstract Description getDescription() throws ParsingException;
 
     @Nonnull
     public String getThumbnailUrl() throws ParsingException {
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/extractors/BandcampPlaylistExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/extractors/BandcampPlaylistExtractor.java
@@ -20,6 +20,7 @@
 import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler;
 import org.schabi.newpipe.extractor.playlist.PlaylistExtractor;
 import org.schabi.newpipe.extractor.services.bandcamp.extractors.streaminfoitem.BandcampPlaylistStreamInfoItemExtractor;
+import org.schabi.newpipe.extractor.stream.Description;
 import org.schabi.newpipe.extractor.stream.StreamInfoItem;
 import org.schabi.newpipe.extractor.stream.StreamInfoItemsCollector;
 
@@ -109,8 +110,8 @@ public long getStreamCount() {
     }
 
     @Override
-    public String getDescription() throws ParsingException {
-        return "";
+    public Description getDescription() throws ParsingException {
+        return Description.EMPTY_DESCRIPTION;
     }
 
     @Nonnull
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/peertube/extractors/PeertubePlaylistExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/peertube/extractors/PeertubePlaylistExtractor.java
@@ -12,6 +12,7 @@
 import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler;
 import org.schabi.newpipe.extractor.playlist.PlaylistExtractor;
 import org.schabi.newpipe.extractor.services.peertube.PeertubeParsingHelper;
+import org.schabi.newpipe.extractor.stream.Description;
 import org.schabi.newpipe.extractor.stream.StreamInfoItem;
 import org.schabi.newpipe.extractor.stream.StreamInfoItemsCollector;
 import org.schabi.newpipe.extractor.utils.Utils;
@@ -66,8 +67,8 @@ public long getStreamCount() {
     }
 
     @Override
-    public String getDescription() throws ParsingException {
-        return "";
+    public Description getDescription() throws ParsingException {
+        return Description.EMPTY_DESCRIPTION;
     }
 
     @Nonnull
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/soundcloud/extractors/SoundcloudPlaylistExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/soundcloud/extractors/SoundcloudPlaylistExtractor.java
@@ -13,6 +13,7 @@
 import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler;
 import org.schabi.newpipe.extractor.playlist.PlaylistExtractor;
 import org.schabi.newpipe.extractor.services.soundcloud.SoundcloudParsingHelper;
+import org.schabi.newpipe.extractor.stream.Description;
 import org.schabi.newpipe.extractor.stream.StreamInfoItem;
 import org.schabi.newpipe.extractor.stream.StreamInfoItemsCollector;
 
@@ -119,8 +120,8 @@ public long getStreamCount() {
     }
 
     @Override
-    public String getDescription() throws ParsingException {
-        return "";
+    public Description getDescription() throws ParsingException {
+        return Description.EMPTY_DESCRIPTION;
     }
 
     @Nonnull
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeMixPlaylistExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubeMixPlaylistExtractor.java
@@ -31,6 +31,7 @@
 import org.schabi.newpipe.extractor.playlist.PlaylistExtractor;
 import org.schabi.newpipe.extractor.playlist.PlaylistInfo;
 import org.schabi.newpipe.extractor.services.youtube.YoutubeParsingHelper;
+import org.schabi.newpipe.extractor.stream.Description;
 import org.schabi.newpipe.extractor.stream.StreamInfoItem;
 import org.schabi.newpipe.extractor.stream.StreamInfoItemsCollector;
 import org.schabi.newpipe.extractor.utils.JsonUtils;
@@ -170,8 +171,8 @@ public long getStreamCount() {
     }
 
     @Override
-    public String getDescription() throws ParsingException {
-        return "";
+    public Description getDescription() throws ParsingException {
+        return Description.EMPTY_DESCRIPTION;
     }
 
     @Nonnull
diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubePlaylistExtractor.java b/extractor/src/main/java/org/schabi/newpipe/extractor/services/youtube/extractors/YoutubePlaylistExtractor.java
@@ -26,6 +26,7 @@
 import org.schabi.newpipe.extractor.playlist.PlaylistExtractor;
 import org.schabi.newpipe.extractor.playlist.PlaylistInfo;
 import org.schabi.newpipe.extractor.services.youtube.YoutubeParsingHelper;
+import org.schabi.newpipe.extractor.stream.Description;
 import org.schabi.newpipe.extractor.stream.StreamInfoItem;
 import org.schabi.newpipe.extractor.stream.StreamInfoItemsCollector;
 import org.schabi.newpipe.extractor.utils.Utils;
@@ -295,8 +296,13 @@ public long getStreamCount() throws ParsingException {
     }
 
     @Override
-    public String getDescription() throws ParsingException {
-        return getTextFromObject(getPlaylistInfo().getObject("description"));
+    public Description getDescription() throws ParsingException {
+        final String description = getTextFromObject(
+                getPlaylistInfo().getObject("description"),
+                true
+        );
+
+        return new Description(description, Description.HTML);
     }
 
     @Nonnull
diff --git a/extractor/src/test/java/org/schabi/newpipe/extractor/services/youtube/YoutubePlaylistExtractorTest.java b/extractor/src/test/java/org/schabi/newpipe/extractor/services/youtube/YoutubePlaylistExtractorTest.java
@@ -26,6 +26,7 @@
 import org.schabi.newpipe.extractor.playlist.PlaylistInfo;
 import org.schabi.newpipe.extractor.services.BasePlaylistExtractorTest;
 import org.schabi.newpipe.extractor.services.youtube.extractors.YoutubePlaylistExtractor;
+import org.schabi.newpipe.extractor.stream.Description;
 import org.schabi.newpipe.extractor.stream.StreamInfoItem;
 
 import java.io.IOException;
@@ -167,8 +168,8 @@ void getPlaylistType() throws ParsingException {
 
         @Test
         public void testDescription() throws ParsingException {
-            final String description = extractor.getDescription();
-            assertContains("pop songs list", description);
+            final Description description = extractor.getDescription();
+            assertContains("pop songs list", description.getContent());
         }
     }
 
@@ -296,8 +297,8 @@ void getPlaylistType() throws ParsingException {
 
         @Test
         public void testDescription() throws ParsingException {
-            final String description = extractor.getDescription();
-            assertContains("I Wanna Rock Super Gigantic Playlist", description);
+            final Description description = extractor.getDescription();
+            assertContains("I Wanna Rock Super Gigantic Playlist", description.getContent());
         }
     }
 
@@ -410,8 +411,8 @@ void getPlaylistType() throws ParsingException {
 
         @Test
         public void testDescription() throws ParsingException {
-            final String description = extractor.getDescription();
-            assertContains("47 episodes", description);
+            final Description description = extractor.getDescription();
+            assertContains("47 episodes", description.getContent());
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@`
`26`	`26`	`import org.schabi.newpipe.extractor.playlist.PlaylistInfo;`
`27`	`27`	`import org.schabi.newpipe.extractor.services.BasePlaylistExtractorTest;`
`28`	`28`	`import org.schabi.newpipe.extractor.services.youtube.extractors.YoutubePlaylistExtractor;`
	`29`	`+import org.schabi.newpipe.extractor.stream.Description;`
`29`	`30`	`import org.schabi.newpipe.extractor.stream.StreamInfoItem;`
`30`	`31`
`31`	`32`	`import java.io.IOException;`
`@@ -167,8 +168,8 @@ void getPlaylistType() throws ParsingException {`
`167`	`168`
`168`	`169`	`@Test`
`169`	`170`	`public void testDescription() throws ParsingException {`
`170`		`- final String description = extractor.getDescription();`
`171`		`- assertContains("pop songs list", description);`
	`171`	`+ final Description description = extractor.getDescription();`
	`172`	`+ assertContains("pop songs list", description.getContent());`
`172`	`173`	`}`
`173`	`174`	`}`
`174`	`175`
`@@ -296,8 +297,8 @@ void getPlaylistType() throws ParsingException {`
`296`	`297`
`297`	`298`	`@Test`
`298`	`299`	`public void testDescription() throws ParsingException {`
`299`		`- final String description = extractor.getDescription();`
`300`		`- assertContains("I Wanna Rock Super Gigantic Playlist", description);`
	`300`	`+ final Description description = extractor.getDescription();`
	`301`	`+ assertContains("I Wanna Rock Super Gigantic Playlist", description.getContent());`
`301`	`302`	`}`
`302`	`303`	`}`
`303`	`304`
`@@ -410,8 +411,8 @@ void getPlaylistType() throws ParsingException {`
`410`	`411`
`411`	`412`	`@Test`
`412`	`413`	`public void testDescription() throws ParsingException {`
`413`		`- final String description = extractor.getDescription();`
`414`		`- assertContains("47 episodes", description);`
	`414`	`+ final Description description = extractor.getDescription();`
	`415`	`+ assertContains("47 episodes", description.getContent());`
`415`	`416`	`}`
`416`	`417`	`}`
`417`	`418`