Skip to content

Commit ffbdfaf

Browse files
committed
Add ContentAvailability.Unknown, add Nonnull, fix typos
1 parent 11bbdfe commit ffbdfaf

5 files changed

Lines changed: 20 additions & 13 deletions

File tree

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,13 @@
2222
/**
2323
* Availability of the stream.
2424
*
25-
* <p>
26-
* A stream may be available to all, restricted to a certain user group
27-
* or time.
28-
* </p>
25+
* <p>A stream may be available to all, restricted to a certain user group or time.</p>
2926
*/
3027
public enum ContentAvailability {
28+
/**
29+
* The availability of the stream is unknown (but clients may assume that it's available).
30+
*/
31+
UNKNOWN,
3132
/**
3233
* The stream is available to all users.
3334
*/

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -587,8 +587,9 @@ public boolean isShortFormContent() throws ParsingException {
587587
* @return The stream's availability
588588
* @throws ParsingException if there is an error in the extraction
589589
*/
590+
@Nonnull
590591
public ContentAvailability getContentAvailability() throws ParsingException {
591-
return ContentAvailability.AVAILABLE;
592+
return ContentAvailability.UNKNOWN;
592593
}
593594

594595
public enum Privacy {

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -386,6 +386,7 @@ private static void extractOptionalData(final StreamInfo streamInfo,
386386
private List<StreamSegment> streamSegments = List.of();
387387
private List<MetaInfo> metaInfo = List.of();
388388
private boolean shortFormContent = false;
389+
@Nonnull
389390
private ContentAvailability contentAvailability = ContentAvailability.AVAILABLE;
390391

391392
/**
@@ -734,11 +735,12 @@ public void setShortFormContent(final boolean isShortFormContent) {
734735
this.shortFormContent = isShortFormContent;
735736
}
736737

738+
@Nonnull
737739
public ContentAvailability getContentAvailability() {
738740
return contentAvailability;
739741
}
740742

741-
public void setContentAvailability(final ContentAvailability availablility) {
742-
this.contentAvailability = availablility;
743+
public void setContentAvailability(@Nonnull final ContentAvailability availability) {
744+
this.contentAvailability = availability;
743745
}
744746
}

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ public class StreamInfoItem extends InfoItem {
4747
private List<Image> uploaderAvatars = List.of();
4848
private boolean uploaderVerified = false;
4949
private boolean shortFormContent = false;
50+
@Nonnull
5051
private ContentAvailability contentAvailability = ContentAvailability.AVAILABLE;
5152

5253
public StreamInfoItem(final int serviceId,
@@ -145,19 +146,20 @@ public void setShortFormContent(final boolean shortFormContent) {
145146
}
146147

147148
/**
148-
* Gets the availablility of the content.
149+
* Gets the availability of the content.
149150
*
150-
* @return The availablility of the stream.
151+
* @return The availability of the stream.
151152
*/
153+
@Nonnull
152154
public ContentAvailability getContentAvailability() {
153155
return contentAvailability;
154156
}
155157

156158
/**
157-
* Sets the availablility of the Stream.
159+
* Sets the availability of the Stream.
158160
*/
159-
public void setContentAvailability(final ContentAvailability availablility) {
160-
this.contentAvailability = availablility;
161+
public void setContentAvailability(@Nonnull final ContentAvailability availability) {
162+
this.contentAvailability = availability;
161163
}
162164

163165
@Override

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,8 @@ default boolean isShortFormContent() throws ParsingException {
158158
* @return The stream's availability
159159
* @throws ParsingException if there is an error in the extraction
160160
*/
161+
@Nonnull
161162
default ContentAvailability getContentAvailability() throws ParsingException {
162-
return ContentAvailability.AVAILABLE;
163+
return ContentAvailability.UNKNOWN;
163164
}
164165
}

0 commit comments

Comments
 (0)