Skip to content

Commit 46b0de7

Browse files
evermind-zzStypox
authored andcommitted
searchfilters: annotate changed method signatures with Nullable or Nonnull
Annotate methods in classes that got some signatures changed due to the searchfilters integration
1 parent e0c7744 commit 46b0de7

27 files changed

+134
-60
lines changed

extractor/src/main/java/org/schabi/newpipe/extractor/linkhandler/ListLinkHandlerFactory.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,18 @@
77
import java.util.List;
88
import java.util.Objects;
99

10+
import javax.annotation.Nonnull;
11+
import javax.annotation.Nullable;
12+
1013
public abstract class ListLinkHandlerFactory extends LinkHandlerFactory {
1114

1215
///////////////////////////////////
1316
// To Override
1417
///////////////////////////////////
1518

1619
public abstract String getUrl(String id,
17-
List<FilterItem> contentFilter,
18-
List<FilterItem> sortFilter)
20+
@Nonnull List<FilterItem> contentFilter,
21+
@Nullable List<FilterItem> sortFilter)
1922
throws ParsingException, UnsupportedOperationException;
2023

2124
public String getUrl(final String id,

extractor/src/main/java/org/schabi/newpipe/extractor/linkhandler/SearchQueryHandlerFactory.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@
55
import org.schabi.newpipe.extractor.search.filter.FilterContainer;
66
import org.schabi.newpipe.extractor.search.filter.FilterItem;
77

8-
import java.util.Collections;
98
import java.util.List;
109

10+
import javax.annotation.Nonnull;
11+
import javax.annotation.Nullable;
12+
1113
public abstract class SearchQueryHandlerFactory extends ListLinkHandlerFactory {
1214
protected final BaseSearchFilters searchFilters;
1315

@@ -20,8 +22,9 @@ protected SearchQueryHandlerFactory(final BaseSearchFilters searchFilters) {
2022
///////////////////////////////////
2123

2224
@Override
23-
public abstract String getUrl(String query, List<FilterItem> selectedContentFilter,
24-
List<FilterItem> selectedSortFilter)
25+
public abstract String getUrl(String query,
26+
@Nonnull List<FilterItem> selectedContentFilter,
27+
@Nullable List<FilterItem> selectedSortFilter)
2528
throws ParsingException, UnsupportedOperationException;
2629

2730
@SuppressWarnings("unused")

extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/linkHandler/BandcampChannelLinkHandlerFactory.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
import java.io.IOException;
1717
import java.util.List;
1818

19+
import javax.annotation.Nonnull;
20+
import javax.annotation.Nullable;
21+
1922
/**
2023
* Artist do have IDs that are useful
2124
*/
@@ -51,8 +54,9 @@ public String getId(final String url) throws ParsingException, UnsupportedOperat
5154
* Uses the mobile endpoint as a "translator" from id to url
5255
*/
5356
@Override
54-
public String getUrl(final String id, final List<FilterItem> contentFilter,
55-
final List<FilterItem> sortFilter)
57+
public String getUrl(final String id,
58+
@Nonnull final List<FilterItem> contentFilter,
59+
@Nullable final List<FilterItem> sortFilter)
5660
throws ParsingException, UnsupportedOperationException {
5761
final JsonObject artistDetails = BandcampExtractorHelper.getArtistDetails(id);
5862
if (artistDetails.getBoolean("error")) {

extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/linkHandler/BandcampCommentsLinkHandlerFactory.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88

99
import java.util.List;
1010

11+
import javax.annotation.Nonnull;
12+
import javax.annotation.Nullable;
13+
1114
/**
1215
* Like in {@link BandcampStreamLinkHandlerFactory}, tracks have no meaningful IDs except for
1316
* their URLs
@@ -46,8 +49,8 @@ public boolean onAcceptUrl(final String url) throws ParsingException {
4649

4750
@Override
4851
public String getUrl(final String id,
49-
final List<FilterItem> contentFilter,
50-
final List<FilterItem> sortFilter)
52+
@Nonnull final List<FilterItem> contentFilter,
53+
@Nullable final List<FilterItem> sortFilter)
5154
throws ParsingException, UnsupportedOperationException {
5255
return id;
5356
}

extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/linkHandler/BandcampFeaturedLinkHandlerFactory.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111

1212
import java.util.List;
1313

14+
import javax.annotation.Nonnull;
15+
import javax.annotation.Nullable;
16+
1417
import static org.schabi.newpipe.extractor.services.bandcamp.extractors.BandcampFeaturedExtractor.FEATURED_API_URL;
1518
import static org.schabi.newpipe.extractor.services.bandcamp.extractors.BandcampFeaturedExtractor.KIOSK_FEATURED;
1619
import static org.schabi.newpipe.extractor.services.bandcamp.extractors.BandcampRadioExtractor.KIOSK_RADIO;
@@ -30,8 +33,8 @@ public static BandcampFeaturedLinkHandlerFactory getInstance() {
3033

3134
@Override
3235
public String getUrl(final String id,
33-
final List<FilterItem> contentFilter,
34-
final List<FilterItem> sortFilter)
36+
@Nonnull final List<FilterItem> contentFilter,
37+
@Nullable final List<FilterItem> sortFilter)
3538
throws ParsingException, UnsupportedOperationException {
3639
if (id.equals(KIOSK_FEATURED)) {
3740
return FEATURED_API_URL; // doesn't have a website

extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/linkHandler/BandcampPlaylistLinkHandlerFactory.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010

1111
import java.util.List;
1212

13+
import javax.annotation.Nonnull;
14+
import javax.annotation.Nullable;
15+
1316
/**
1417
* Just as with streams, the album ids are essentially useless for us.
1518
*/
@@ -32,8 +35,8 @@ public String getId(final String url) throws ParsingException, UnsupportedOperat
3235

3336
@Override
3437
public String getUrl(final String url,
35-
final List<FilterItem> contentFilter,
36-
final List<FilterItem> sortFilter)
38+
@Nonnull final List<FilterItem> contentFilter,
39+
@Nullable final List<FilterItem> sortFilter)
3740
throws ParsingException, UnsupportedOperationException {
3841
return url;
3942
}

extractor/src/main/java/org/schabi/newpipe/extractor/services/bandcamp/linkHandler/BandcampSearchQueryHandlerFactory.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313
import java.io.UnsupportedEncodingException;
1414
import java.util.List;
1515

16+
import javax.annotation.Nonnull;
17+
import javax.annotation.Nullable;
18+
1619
public final class BandcampSearchQueryHandlerFactory extends SearchQueryHandlerFactory {
1720

1821
private static final BandcampSearchQueryHandlerFactory INSTANCE
@@ -28,11 +31,10 @@ public static BandcampSearchQueryHandlerFactory getInstance() {
2831

2932
@Override
3033
public String getUrl(final String query,
31-
final List<FilterItem> selectedContentFilter,
32-
final List<FilterItem> selectedSortFilter)
34+
@Nonnull final List<FilterItem> selectedContentFilter,
35+
@Nullable final List<FilterItem> selectedSortFilter)
3336
throws ParsingException, UnsupportedOperationException {
3437

35-
3638
searchFilters.setSelectedSortFilter(selectedSortFilter);
3739
searchFilters.setSelectedContentFilter(selectedContentFilter);
3840

extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/linkHandler/MediaCCCConferenceLinkHandlerFactory.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@
88

99
import java.util.List;
1010

11+
import javax.annotation.Nonnull;
12+
import javax.annotation.Nullable;
13+
1114
public final class MediaCCCConferenceLinkHandlerFactory extends ListLinkHandlerFactory {
1215

1316
private static final MediaCCCConferenceLinkHandlerFactory INSTANCE
1417
= new MediaCCCConferenceLinkHandlerFactory();
15-
1618
public static final String CONFERENCE_API_ENDPOINT
1719
= "https://api.media.ccc.de/public/conferences/";
1820
public static final String CONFERENCE_PATH = "https://media.ccc.de/c/";
@@ -29,8 +31,8 @@ public static MediaCCCConferenceLinkHandlerFactory getInstance() {
2931

3032
@Override
3133
public String getUrl(final String id,
32-
final List<FilterItem> contentFilter,
33-
final List<FilterItem> sortFilter)
34+
@Nonnull final List<FilterItem> contentFilter,
35+
@Nullable final List<FilterItem> sortFilter)
3436
throws ParsingException, UnsupportedOperationException {
3537
return CONFERENCE_PATH + id;
3638
}

extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/linkHandler/MediaCCCConferencesListLinkHandlerFactory.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77

88
import java.util.List;
99

10+
import javax.annotation.Nonnull;
11+
import javax.annotation.Nullable;
12+
1013
public final class MediaCCCConferencesListLinkHandlerFactory extends ListLinkHandlerFactory {
1114

1215
private static final MediaCCCConferencesListLinkHandlerFactory INSTANCE =
@@ -18,16 +21,15 @@ private MediaCCCConferencesListLinkHandlerFactory() {
1821
public static MediaCCCConferencesListLinkHandlerFactory getInstance() {
1922
return INSTANCE;
2023
}
21-
2224
@Override
2325
public String getId(final String url) throws ParsingException, UnsupportedOperationException {
2426
return "conferences";
2527
}
2628

2729
@Override
2830
public String getUrl(final String id,
29-
final List<FilterItem> contentFilter,
30-
final List<FilterItem> sortFilter)
31+
@Nonnull final List<FilterItem> contentFilter,
32+
@Nullable final List<FilterItem> sortFilter)
3133
throws ParsingException, UnsupportedOperationException {
3234
return "https://media.ccc.de/public/conferences";
3335
}

extractor/src/main/java/org/schabi/newpipe/extractor/services/media_ccc/linkHandler/MediaCCCLiveListLinkHandlerFactory.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@
88
import java.util.List;
99
import java.util.regex.Pattern;
1010

11+
import javax.annotation.Nonnull;
12+
import javax.annotation.Nullable;
13+
1114
public final class MediaCCCLiveListLinkHandlerFactory extends ListLinkHandlerFactory {
1215

1316
private static final MediaCCCLiveListLinkHandlerFactory INSTANCE =
1417
new MediaCCCLiveListLinkHandlerFactory();
15-
1618
private static final String STREAM_PATTERN = "^(?:https?://)?media\\.ccc\\.de/live$";
1719

1820
private MediaCCCLiveListLinkHandlerFactory() {
@@ -34,8 +36,8 @@ public boolean onAcceptUrl(final String url) throws ParsingException {
3436

3537
@Override
3638
public String getUrl(final String id,
37-
final List<FilterItem> contentFilter,
38-
final List<FilterItem> sortFilter)
39+
@Nonnull final List<FilterItem> contentFilter,
40+
@Nullable final List<FilterItem> sortFilter)
3941
throws ParsingException, UnsupportedOperationException {
4042
// FIXME: wrong URL; should be https://streaming.media.ccc.de/{conference_slug}/{room_slug}
4143
return "https://media.ccc.de/live";

0 commit comments

Comments
 (0)