Bug 1292903 - Add comment explaining getUrlFromAboutReader r?sebastian draft
authorAndrzej Hunt <ahunt@mozilla.com>
Wed, 10 Aug 2016 10:14:59 -0700
changeset 399215 e9b470dd4ef793d9247d1231e390ceb49d835449
parent 399214 747c9b0700614de86aab6e53a62c47942daaeeed
child 527868 746805b9292c3702be3c11bd2b46c43f0841ee0b
push id25763
push userahunt@mozilla.com
push dateWed, 10 Aug 2016 17:17:11 +0000
reviewerssebastian
bugs1292903
milestone51.0a1
Bug 1292903 - Add comment explaining getUrlFromAboutReader r?sebastian MozReview-Commit-ID: EnbsJNl9N4n
mobile/android/base/java/org/mozilla/gecko/reader/ReaderModeUtils.java
--- a/mobile/android/base/java/org/mozilla/gecko/reader/ReaderModeUtils.java
+++ b/mobile/android/base/java/org/mozilla/gecko/reader/ReaderModeUtils.java
@@ -7,16 +7,24 @@ package org.mozilla.gecko.reader;
 import org.mozilla.gecko.AboutPages;
 import org.mozilla.gecko.util.StringUtils;
 
 import android.net.Uri;
 
 public class ReaderModeUtils {
     private static final String LOGTAG = "ReaderModeUtils";
 
+    /**
+     * Extract the URL from a valid about:reader URL. You may want to use stripAboutReaderUrl
+     * instead to always obtain a valid String.
+     *
+     * @see #stripAboutReaderUrl(String) for a safer version that returns the original URL for malformed/invalid
+     *     URLs.
+     * @return <code>null</code> if the URL is malformed or doesn't contain a URL parameter.
+     */
     public static String getUrlFromAboutReader(String aboutReaderUrl) {
         return StringUtils.getQueryParameter(aboutReaderUrl, "url");
     }
 
     public static boolean isEnteringReaderMode(String currentUrl, String newUrl) {
         if (currentUrl == null || newUrl == null) {
             return false;
         }