Replace avatar and thumbnail URLs attributes and methods to List<Image> in InfoItemExtractors

This commit is contained in:
AudricV 2022-07-20 23:31:47 +02:00
parent 2f3ee8a3f2
commit ca1d4a6fa4
No known key found for this signature in database
GPG Key ID: DA92EC7905614198
3 changed files with 41 additions and 28 deletions

View File

@ -2,8 +2,12 @@ package org.schabi.newpipe.extractor;
import org.schabi.newpipe.extractor.exceptions.ParsingException; import org.schabi.newpipe.extractor.exceptions.ParsingException;
import javax.annotation.Nonnull;
import java.util.List;
public interface InfoItemExtractor { public interface InfoItemExtractor {
String getName() throws ParsingException; String getName() throws ParsingException;
String getUrl() throws ParsingException; String getUrl() throws ParsingException;
String getThumbnailUrl() throws ParsingException; @Nonnull
List<Image> getThumbnails() throws ParsingException;
} }

View File

@ -1,5 +1,6 @@
package org.schabi.newpipe.extractor.comments; package org.schabi.newpipe.extractor.comments;
import org.schabi.newpipe.extractor.Image;
import org.schabi.newpipe.extractor.InfoItemExtractor; import org.schabi.newpipe.extractor.InfoItemExtractor;
import org.schabi.newpipe.extractor.Page; import org.schabi.newpipe.extractor.Page;
import org.schabi.newpipe.extractor.exceptions.ParsingException; import org.schabi.newpipe.extractor.exceptions.ParsingException;
@ -8,7 +9,9 @@ import org.schabi.newpipe.extractor.services.youtube.extractors.YoutubeCommentsI
import org.schabi.newpipe.extractor.stream.Description; import org.schabi.newpipe.extractor.stream.Description;
import org.schabi.newpipe.extractor.stream.StreamExtractor; import org.schabi.newpipe.extractor.stream.StreamExtractor;
import javax.annotation.Nonnull;
import javax.annotation.Nullable; import javax.annotation.Nullable;
import java.util.List;
public interface CommentsInfoItemExtractor extends InfoItemExtractor { public interface CommentsInfoItemExtractor extends InfoItemExtractor {
@ -77,8 +80,9 @@ public interface CommentsInfoItemExtractor extends InfoItemExtractor {
return ""; return "";
} }
default String getUploaderAvatarUrl() throws ParsingException { @Nonnull
return ""; default List<Image> getUploaderAvatars() throws ParsingException {
return List.of();
} }
/** /**

View File

@ -1,39 +1,41 @@
package org.schabi.newpipe.extractor.stream;
import org.schabi.newpipe.extractor.InfoItemExtractor;
import org.schabi.newpipe.extractor.exceptions.ParsingException;
import org.schabi.newpipe.extractor.localization.DateWrapper;
import javax.annotation.Nullable;
/* /*
* Created by Christian Schabesberger on 28.02.16. * Created by Christian Schabesberger on 28.02.16.
* *
* Copyright (C) Christian Schabesberger 2016 <chris.schabesberger@mailbox.org> * Copyright (C) Christian Schabesberger 2016 <chris.schabesberger@mailbox.org>
* StreamInfoItemExtractor.java is part of NewPipe. * StreamInfoItemExtractor.java is part of NewPipe Extractor.
* *
* NewPipe is free software: you can redistribute it and/or modify * NewPipe Extractor is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or * the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version. * (at your option) any later version.
* *
* NewPipe is distributed in the hope that it will be useful, * NewPipe Extractor is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details. * GNU General Public License for more details.
* *
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with NewPipe. If not, see <http://www.gnu.org/licenses/>. * along with NewPipe Extractor. If not, see <https://www.gnu.org/licenses/>.
*/ */
public interface StreamInfoItemExtractor extends InfoItemExtractor { package org.schabi.newpipe.extractor.stream;
import org.schabi.newpipe.extractor.Image;
import org.schabi.newpipe.extractor.InfoItemExtractor;
import org.schabi.newpipe.extractor.exceptions.ParsingException;
import org.schabi.newpipe.extractor.localization.DateWrapper;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.List;
public interface StreamInfoItemExtractor extends InfoItemExtractor {
/** /**
* Get the stream type * Get the stream type
* *
* @return the stream type * @return the stream type
* @throws ParsingException thrown if there is an error in the extraction * @throws ParsingException if there is an error in the extraction
*/ */
StreamType getStreamType() throws ParsingException; StreamType getStreamType() throws ParsingException;
@ -41,7 +43,7 @@ public interface StreamInfoItemExtractor extends InfoItemExtractor {
* Check if the stream is an ad. * Check if the stream is an ad.
* *
* @return {@code true} if the stream is an ad. * @return {@code true} if the stream is an ad.
* @throws ParsingException thrown if there is an error in the extraction * @throws ParsingException if there is an error in the extraction
*/ */
boolean isAd() throws ParsingException; boolean isAd() throws ParsingException;
@ -49,7 +51,7 @@ public interface StreamInfoItemExtractor extends InfoItemExtractor {
* Get the stream duration in seconds * Get the stream duration in seconds
* *
* @return the stream duration in seconds * @return the stream duration in seconds
* @throws ParsingException thrown if there is an error in the extraction * @throws ParsingException if there is an error in the extraction
*/ */
long getDuration() throws ParsingException; long getDuration() throws ParsingException;
@ -57,7 +59,7 @@ public interface StreamInfoItemExtractor extends InfoItemExtractor {
* Parses the number of views * Parses the number of views
* *
* @return the number of views or -1 for live streams * @return the number of views or -1 for live streams
* @throws ParsingException thrown if there is an error in the extraction * @throws ParsingException if there is an error in the extraction
*/ */
long getViewCount() throws ParsingException; long getViewCount() throws ParsingException;
@ -65,27 +67,29 @@ public interface StreamInfoItemExtractor extends InfoItemExtractor {
* Get the uploader name * Get the uploader name
* *
* @return the uploader name * @return the uploader name
* @throws ParsingException if parsing fails * @throws ParsingException if there is an error in the extraction
*/ */
String getUploaderName() throws ParsingException; String getUploaderName() throws ParsingException;
String getUploaderUrl() throws ParsingException; String getUploaderUrl() throws ParsingException;
/** /**
* Get the uploader's avatar * Get the uploader avatars.
* *
* @return The uploader's avatar url or {@code null} if not provided by the service. * @return the uploader avatars or an empty list if not provided by the service
* @throws ParsingException if there is an error in the extraction * @throws ParsingException if there is an error in the extraction
*/ */
@Nullable @Nonnull
String getUploaderAvatarUrl() throws ParsingException; default List<Image> getUploaderAvatars() throws ParsingException {
return List.of();
}
/** /**
* Whether the uploader has been verified by the service's provider. * Whether the uploader has been verified by the service's provider.
* If there is no verification implemented, return <code>false</code>. * If there is no verification implemented, return <code>false</code>.
* *
* @return whether the uploader has been verified by the service's provider * @return whether the uploader has been verified by the service's provider
* @throws ParsingException * @throws ParsingException if there is an error in the extraction
*/ */
boolean isUploaderVerified() throws ParsingException; boolean isUploaderVerified() throws ParsingException;
@ -109,8 +113,8 @@ public interface StreamInfoItemExtractor extends InfoItemExtractor {
* </p> * </p>
* *
* @return The date and time (can be approximated) this item was uploaded or {@code null}. * @return The date and time (can be approximated) this item was uploaded or {@code null}.
* @throws ParsingException if there is an error in the extraction * @throws ParsingException if there is an error in the extraction or the extracted date
* or the extracted date couldn't be parsed. * couldn't be parsed
* @see #getTextualUploadDate() * @see #getTextualUploadDate()
*/ */
@Nullable @Nullable
@ -137,6 +141,7 @@ public interface StreamInfoItemExtractor extends InfoItemExtractor {
* </p> * </p>
* *
* @return whether the stream is a short-form content * @return whether the stream is a short-form content
* @throws ParsingException if there is an error in the extraction
*/ */
default boolean isShortFormContent() throws ParsingException { default boolean isShortFormContent() throws ParsingException {
return false; return false;