Merge pull request #417 from Isira-Seneviratne/Use_Java_8_Date_Time_API

Use the Java 8 Date/Time API.
TeamNewPipe · Nov 1, 2020 · 8cbdec6 · 8cbdec6
2 parents 6cc50b5 + fcdfe7d
commit 8cbdec6
Show file tree

Hide file tree

Showing 16 changed files with 168 additions and 216 deletions.
diff --git a/README.md b/README.md
@@ -13,6 +13,8 @@ If you're using Gradle, you could add NewPipe Extractor as a dependency with the
 1. Add `maven { url 'https://jitpack.io' }` to the `repositories` in your `build.gradle`.
 2. Add `implementation 'com.github.TeamNewPipe:NewPipeExtractor:v0.20.1'`the `dependencies` in your `build.gradle`. Replace `v0.20.1` with the latest release.
 
+**Note:** To use NewPipe Extractor in projects with a `minSdkVersion` below 26, [API desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) is required.
+
 ### Testing changes
 
 To test changes quickly you can build the library locally. A good approach would be to add something like the following to your `settings.gradle`:

diff --git a/build.gradle b/build.gradle
@@ -2,8 +2,8 @@ allprojects {
     apply plugin: 'java-library'
     apply plugin: 'maven'
 
-    sourceCompatibility = 1.7
-    targetCompatibility = 1.7
+    sourceCompatibility = 1.8
+    targetCompatibility = 1.8
 
     version 'v0.20.2'
     group 'com.github.TeamNewPipe'

diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/localization/DateWrapper.java b/extractor/src/main/java/org/schabi/newpipe/extractor/localization/DateWrapper.java
@@ -3,30 +3,61 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 
 import java.io.Serializable;
+import java.time.OffsetDateTime;
+import java.time.ZoneOffset;
 import java.util.Calendar;
+import java.util.GregorianCalendar;
 
 /**
- * A wrapper class that provides a field to describe if the date is precise or just an approximation.
+ * A wrapper class that provides a field to describe if the date/time is precise or just an approximation.
  */
 public class DateWrapper implements Serializable {
-    @NonNull private final Calendar date;
+    @NonNull private final OffsetDateTime offsetDateTime;
     private final boolean isApproximation;
 
-    public DateWrapper(@NonNull Calendar date) {
-        this(date, false);
+    /**
+     * @deprecated Use {@link #DateWrapper(OffsetDateTime)} instead.
+     */
+    @Deprecated
+    public DateWrapper(@NonNull Calendar calendar) {
+        this(calendar, false);
+    }
+
+    /**
+     * @deprecated Use {@link #DateWrapper(OffsetDateTime, boolean)} instead.
+     */
+    @Deprecated
+    public DateWrapper(@NonNull Calendar calendar, boolean isApproximation) {
+        offsetDateTime = OffsetDateTime.ofInstant(calendar.toInstant(), ZoneOffset.UTC);
+        this.isApproximation = isApproximation;
     }
 
-    public DateWrapper(@NonNull Calendar date, boolean isApproximation) {
-        this.date = date;
+    public DateWrapper(@NonNull OffsetDateTime offsetDateTime) {
+        this(offsetDateTime, false);
+    }
+
+    public DateWrapper(@NonNull OffsetDateTime offsetDateTime, boolean isApproximation) {
+        this.offsetDateTime = offsetDateTime.withOffsetSameInstant(ZoneOffset.UTC);
         this.isApproximation = isApproximation;
     }
 
     /**
-     * @return the wrapped date.
+     * @return the wrapped date/time as a {@link Calendar}.
+     *
+     * @deprecated use {@link #offsetDateTime()} instead.
      */
+    @Deprecated
     @NonNull
     public Calendar date() {
-        return date;
+        return GregorianCalendar.from(offsetDateTime.toZonedDateTime());
+    }
+
+    /**
+     * @return the wrapped date/time.
+     */
+    @NonNull
+    public OffsetDateTime offsetDateTime() {
+        return offsetDateTime;
     }
 
     /**

diff --git a/extractor/src/main/java/org/schabi/newpipe/extractor/localization/TimeAgoParser.java b/extractor/src/main/java/org/schabi/newpipe/extractor/localization/TimeAgoParser.java
@@ -2,10 +2,11 @@
 
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 import org.schabi.newpipe.extractor.timeago.PatternsHolder;
-import org.schabi.newpipe.extractor.timeago.TimeAgoUnit;
 import org.schabi.newpipe.extractor.utils.Parser;
 
-import java.util.Calendar;
+import java.time.OffsetDateTime;
+import java.time.ZoneOffset;
+import java.time.temporal.ChronoUnit;
 import java.util.Collection;
 import java.util.Map;
 import java.util.regex.Pattern;
@@ -16,7 +17,7 @@
  */
 public class TimeAgoParser {
     private final PatternsHolder patternsHolder;
-    private final Calendar consistentNow;
+    private final OffsetDateTime now;
 
     /**
      * Creates a helper to parse upload dates in the format '2 days ago'.
@@ -28,7 +29,7 @@ public class TimeAgoParser {
      */
     public TimeAgoParser(PatternsHolder patternsHolder) {
         this.patternsHolder = patternsHolder;
-        consistentNow = Calendar.getInstance();
+        now = OffsetDateTime.now(ZoneOffset.UTC);
     }
 
     /**
@@ -42,14 +43,14 @@ public TimeAgoParser(PatternsHolder patternsHolder) {
      * @throws ParsingException if the time unit could not be recognized
      */
     public DateWrapper parse(String textualDate) throws ParsingException {
-        for (Map.Entry<TimeAgoUnit, Map<String, Integer>> caseUnitEntry : patternsHolder.specialCases().entrySet()) {
-            final TimeAgoUnit timeAgoUnit = caseUnitEntry.getKey();
+        for (Map.Entry<ChronoUnit, Map<String, Integer>> caseUnitEntry : patternsHolder.specialCases().entrySet()) {
+            final ChronoUnit chronoUnit = caseUnitEntry.getKey();
             for (Map.Entry<String, Integer> caseMapToAmountEntry : caseUnitEntry.getValue().entrySet()) {
                 final String caseText = caseMapToAmountEntry.getKey();
                 final Integer caseAmount = caseMapToAmountEntry.getValue();
 
                 if (textualDateMatches(textualDate, caseText)) {
-                    return getResultFor(caseAmount, timeAgoUnit);
+                    return getResultFor(caseAmount, chronoUnit);
                 }
             }
         }
@@ -63,22 +64,22 @@ public DateWrapper parse(String textualDate) throws ParsingException {
             timeAgoAmount = 1;
         }
 
-        final TimeAgoUnit timeAgoUnit = parseTimeAgoUnit(textualDate);
-        return getResultFor(timeAgoAmount, timeAgoUnit);
+        final ChronoUnit chronoUnit = parseChronoUnit(textualDate);
+        return getResultFor(timeAgoAmount, chronoUnit);
     }
 
     private int parseTimeAgoAmount(String textualDate) throws NumberFormatException {
         String timeValueStr = textualDate.replaceAll("\\D+", "");
         return Integer.parseInt(timeValueStr);
     }
 
-    private TimeAgoUnit parseTimeAgoUnit(String textualDate) throws ParsingException {
-        for (Map.Entry<TimeAgoUnit, Collection<String>> entry : patternsHolder.asMap().entrySet()) {
-            final TimeAgoUnit timeAgoUnit = entry.getKey();
+    private ChronoUnit parseChronoUnit(String textualDate) throws ParsingException {
+        for (Map.Entry<ChronoUnit, Collection<String>> entry : patternsHolder.asMap().entrySet()) {
+            final ChronoUnit chronoUnit = entry.getKey();
 
             for (String agoPhrase : entry.getValue()) {
                 if (textualDateMatches(textualDate, agoPhrase)) {
-                    return timeAgoUnit;
+                    return chronoUnit;
                 }
             }
         }
@@ -112,65 +113,35 @@ private boolean textualDateMatches(String textualDate, String agoPhrase) {
         }
     }
 
-    private DateWrapper getResultFor(int timeAgoAmount, TimeAgoUnit timeAgoUnit) {
-        final Calendar calendarTime = getNow();
+    private DateWrapper getResultFor(int timeAgoAmount, ChronoUnit chronoUnit) {
+        OffsetDateTime offsetDateTime = now;
         boolean isApproximation = false;
 
-        switch (timeAgoUnit) {
+        switch (chronoUnit) {
             case SECONDS:
-                calendarTime.add(Calendar.SECOND, -timeAgoAmount);
-                break;
-
             case MINUTES:
-                calendarTime.add(Calendar.MINUTE, -timeAgoAmount);
-                break;
-
             case HOURS:
-                calendarTime.add(Calendar.HOUR_OF_DAY, -timeAgoAmount);
+                offsetDateTime = offsetDateTime.minus(timeAgoAmount, chronoUnit);
                 break;
 
             case DAYS:
-                calendarTime.add(Calendar.DAY_OF_MONTH, -timeAgoAmount);
-                isApproximation = true;
-                break;
-
             case WEEKS:
-                calendarTime.add(Calendar.WEEK_OF_YEAR, -timeAgoAmount);
-                isApproximation = true;
-                break;
-
             case MONTHS:
-                calendarTime.add(Calendar.MONTH, -timeAgoAmount);
+                offsetDateTime = offsetDateTime.minus(timeAgoAmount, chronoUnit);
                 isApproximation = true;
                 break;
 
             case YEARS:
-                calendarTime.add(Calendar.YEAR, -timeAgoAmount);
-                // Prevent `PrettyTime` from showing '12 months ago'.
-                calendarTime.add(Calendar.DAY_OF_MONTH, -1);
+                // minusDays is needed to prevent `PrettyTime` from showing '12 months ago'.
+                offsetDateTime = offsetDateTime.minusYears(timeAgoAmount).minusDays(1);
                 isApproximation = true;
                 break;
         }
 
         if (isApproximation) {
-            markApproximatedTime(calendarTime);
+            offsetDateTime = offsetDateTime.truncatedTo(ChronoUnit.HOURS);
         }
 
-        return new DateWrapper(calendarTime, isApproximation);
-    }
-
-    private Calendar getNow() {
-        return (Calendar) consistentNow.clone();
-    }
-
-    /**
-     * Marks the time as approximated by setting minutes, seconds and milliseconds to 0.
-     *
-     * @param calendarTime Time to be marked as approximated
-     */
-    private void markApproximatedTime(Calendar calendarTime) {
-        calendarTime.set(Calendar.MINUTE, 0);
-        calendarTime.set(Calendar.SECOND, 0);
-        calendarTime.set(Calendar.MILLISECOND, 0);
+        return new DateWrapper(offsetDateTime, isApproximation);
     }
 }
diff --git a/...ava/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCParsingHelper.java b/...ava/org/schabi/newpipe/extractor/services/media_ccc/extractors/MediaCCCParsingHelper.java
@@ -2,28 +2,17 @@
 
 import org.schabi.newpipe.extractor.exceptions.ParsingException;
 
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
-import java.util.Calendar;
-import java.util.Date;
-import java.util.TimeZone;
+import java.time.OffsetDateTime;
+import java.time.format.DateTimeParseException;
 
 public final class MediaCCCParsingHelper {
     private MediaCCCParsingHelper() { }
 
-    public static Calendar parseDateFrom(final String textualUploadDate) throws ParsingException {
-        final Date date;
+    public static OffsetDateTime parseDateFrom(final String textualUploadDate) throws ParsingException {
         try {
-            final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
-            sdf.setTimeZone(TimeZone.getTimeZone("GMT"));
-            date = sdf.parse(textualUploadDate);
-        } catch (ParseException e) {
+            return OffsetDateTime.parse(textualUploadDate);
+        } catch (DateTimeParseException e) {
             throw new ParsingException("Could not parse date: \"" + textualUploadDate + "\"", e);
         }
-
-        final Calendar uploadDate = Calendar.getInstance();
-        uploadDate.setTime(date);
-        return uploadDate;
     }
-
 }
diff --git a/...r/src/main/java/org/schabi/newpipe/extractor/services/peertube/PeertubeParsingHelper.java b/...r/src/main/java/org/schabi/newpipe/extractor/services/peertube/PeertubeParsingHelper.java
@@ -2,7 +2,6 @@
 
 import com.grack.nanojson.JsonArray;
 import com.grack.nanojson.JsonObject;
-
 import org.schabi.newpipe.extractor.InfoItemsCollector;
 import org.schabi.newpipe.extractor.Page;
 import org.schabi.newpipe.extractor.exceptions.ContentNotAvailableException;
@@ -12,11 +11,10 @@
 import org.schabi.newpipe.extractor.utils.Parser;
 import org.schabi.newpipe.extractor.utils.Utils;
 
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
-import java.util.Calendar;
-import java.util.Date;
-import java.util.TimeZone;
+import java.time.Instant;
+import java.time.OffsetDateTime;
+import java.time.ZoneOffset;
+import java.time.format.DateTimeParseException;
 
 public class PeertubeParsingHelper {
     public static final String START_KEY = "start";
@@ -34,19 +32,12 @@ public static void validate(final JsonObject json) throws ContentNotAvailableExc
         }
     }
 
-    public static Calendar parseDateFrom(final String textualUploadDate) throws ParsingException {
-        final Date date;
+    public static OffsetDateTime parseDateFrom(final String textualUploadDate) throws ParsingException {
         try {
-            final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.S'Z'");
-            sdf.setTimeZone(TimeZone.getTimeZone("GMT"));
-            date = sdf.parse(textualUploadDate);
-        } catch (ParseException e) {
+            return OffsetDateTime.ofInstant(Instant.parse(textualUploadDate), ZoneOffset.UTC);
+        } catch (DateTimeParseException e) {
             throw new ParsingException("Could not parse date: \"" + textualUploadDate + "\"", e);
         }
-
-        final Calendar uploadDate = Calendar.getInstance();
-        uploadDate.setTime(date);
-        return uploadDate;
     }
 
     public static Page getNextPage(final String prevPageUrl, final long total) {

diff --git a/...c/main/java/org/schabi/newpipe/extractor/services/soundcloud/SoundcloudParsingHelper.java b/...c/main/java/org/schabi/newpipe/extractor/services/soundcloud/SoundcloudParsingHelper.java
@@ -21,16 +21,18 @@
 import org.schabi.newpipe.extractor.stream.StreamInfoItemsCollector;
 import org.schabi.newpipe.extractor.utils.Parser;
 import org.schabi.newpipe.extractor.utils.Parser.RegexException;
-import org.schabi.newpipe.extractor.utils.Utils;
 
 import javax.annotation.Nonnull;
 import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.net.URLEncoder;
-import java.text.ParseException;
-import java.text.SimpleDateFormat;
-import java.util.*;
+import java.time.OffsetDateTime;
+import java.time.format.DateTimeFormatter;
+import java.time.format.DateTimeParseException;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
 
 import static java.util.Collections.singletonList;
 import static org.schabi.newpipe.extractor.ServiceList.SoundCloud;
@@ -95,23 +97,16 @@ static boolean checkIfHardcodedClientIdIsValid() {
         }
     }
 
-    public static Calendar parseDateFrom(String textualUploadDate) throws ParsingException {
-        Date date;
+    public static OffsetDateTime parseDateFrom(String textualUploadDate) throws ParsingException {
         try {
-            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
-            sdf.setTimeZone(TimeZone.getTimeZone("GMT"));
-            date = sdf.parse(textualUploadDate);
-        } catch (ParseException e1) {
+            return OffsetDateTime.parse(textualUploadDate);
+        } catch (DateTimeParseException e1) {
             try {
-                date = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss +0000").parse(textualUploadDate);
-            } catch (ParseException e2) {
+                return OffsetDateTime.parse(textualUploadDate, DateTimeFormatter.ofPattern("yyyy/MM/dd HH:mm:ss +0000"));
+            } catch (DateTimeParseException e2) {
                 throw new ParsingException("Could not parse date: \"" + textualUploadDate + "\"" + ", " + e1.getMessage(), e2);
             }
         }
-
-        final Calendar uploadDate = Calendar.getInstance();
-        uploadDate.setTime(date);
-        return uploadDate;
     }
 
     /**