[webview] Annotate API parameters as @Nullable or @NonNull
Annotate WebView API parameters as either @Nullable or @NonNull. When a
method returns a nullable type, add this to the javadoc as well.
Deprecated methods were ignored.
Bug: 119254822
Test: none (only changes annotations, no change in logic)
Change-Id: I701108240fd5905e1085a9e8bcce44567e517892
diff --git a/api/current.txt b/api/current.txt
index aefe209..e9a65fa 100644
--- a/api/current.txt
+++ b/api/current.txt
@@ -55158,12 +55158,12 @@
}
public class WebView extends android.widget.AbsoluteLayout implements android.view.ViewGroup.OnHierarchyChangeListener android.view.ViewTreeObserver.OnGlobalFocusChangeListener {
- ctor public WebView(android.content.Context);
- ctor public WebView(android.content.Context, android.util.AttributeSet);
- ctor public WebView(android.content.Context, android.util.AttributeSet, int);
- ctor public WebView(android.content.Context, android.util.AttributeSet, int, int);
- ctor @Deprecated public WebView(android.content.Context, android.util.AttributeSet, int, boolean);
- method public void addJavascriptInterface(Object, String);
+ ctor public WebView(@NonNull android.content.Context);
+ ctor public WebView(@NonNull android.content.Context, @Nullable android.util.AttributeSet);
+ ctor public WebView(@NonNull android.content.Context, @Nullable android.util.AttributeSet, int);
+ ctor public WebView(@NonNull android.content.Context, @Nullable android.util.AttributeSet, int, int);
+ ctor @Deprecated public WebView(@NonNull android.content.Context, @Nullable android.util.AttributeSet, int, boolean);
+ method public void addJavascriptInterface(@NonNull Object, @NonNull String);
method public boolean canGoBack();
method public boolean canGoBackOrForward(int);
method public boolean canGoForward();
@@ -55177,40 +55177,40 @@
method public void clearMatches();
method public void clearSslPreferences();
method @Deprecated public void clearView();
- method public android.webkit.WebBackForwardList copyBackForwardList();
+ method @NonNull public android.webkit.WebBackForwardList copyBackForwardList();
method @Deprecated public android.print.PrintDocumentAdapter createPrintDocumentAdapter();
- method public android.print.PrintDocumentAdapter createPrintDocumentAdapter(String);
- method public android.webkit.WebMessagePort[] createWebMessageChannel();
+ method @NonNull public android.print.PrintDocumentAdapter createPrintDocumentAdapter(@NonNull String);
+ method @NonNull public android.webkit.WebMessagePort[] createWebMessageChannel();
method public void destroy();
method public static void disableWebView();
- method public void documentHasImages(android.os.Message);
+ method public void documentHasImages(@NonNull android.os.Message);
method public static void enableSlowWholeDocumentDraw();
- method public void evaluateJavascript(String, @Nullable android.webkit.ValueCallback<java.lang.String>);
+ method public void evaluateJavascript(@NonNull String, @Nullable android.webkit.ValueCallback<java.lang.String>);
method @Deprecated @Nullable public static String findAddress(String);
method @Deprecated public int findAll(String);
- method public void findAllAsync(String);
+ method public void findAllAsync(@NonNull String);
method public void findNext(boolean);
method public void flingScroll(int, int);
method @Deprecated public void freeMemory();
method @Nullable public android.net.http.SslCertificate getCertificate();
method @android.view.ViewDebug.ExportedProperty(category="webview") public int getContentHeight();
method @Nullable public static android.content.pm.PackageInfo getCurrentWebViewPackage();
- method public android.graphics.Bitmap getFavicon();
- method public android.webkit.WebView.HitTestResult getHitTestResult();
+ method @Nullable public android.graphics.Bitmap getFavicon();
+ method @NonNull public android.webkit.WebView.HitTestResult getHitTestResult();
method @Deprecated @Nullable public String[] getHttpAuthUsernamePassword(String, String);
- method @android.view.ViewDebug.ExportedProperty(category="webview") public String getOriginalUrl();
+ method @android.view.ViewDebug.ExportedProperty(category="webview") @Nullable public String getOriginalUrl();
method public int getProgress();
method public boolean getRendererPriorityWaivedWhenNotVisible();
method public int getRendererRequestedPriority();
method @NonNull public static android.net.Uri getSafeBrowsingPrivacyPolicyUrl();
method @Deprecated @android.view.ViewDebug.ExportedProperty(category="webview") public float getScale();
- method public android.webkit.WebSettings getSettings();
+ method @NonNull public android.webkit.WebSettings getSettings();
method @NonNull public android.view.textclassifier.TextClassifier getTextClassifier();
- method @android.view.ViewDebug.ExportedProperty(category="webview") public String getTitle();
- method @android.view.ViewDebug.ExportedProperty(category="webview") public String getUrl();
+ method @android.view.ViewDebug.ExportedProperty(category="webview") @Nullable public String getTitle();
+ method @android.view.ViewDebug.ExportedProperty(category="webview") @Nullable public String getUrl();
method @Nullable public android.webkit.WebChromeClient getWebChromeClient();
method @NonNull public static ClassLoader getWebViewClassLoader();
- method public android.webkit.WebViewClient getWebViewClient();
+ method @NonNull public android.webkit.WebViewClient getWebViewClient();
method @NonNull public android.os.Looper getWebViewLooper();
method @Nullable public android.webkit.WebViewRenderProcess getWebViewRenderProcess();
method @Nullable public android.webkit.WebViewRenderProcessClient getWebViewRenderProcessClient();
@@ -55219,10 +55219,10 @@
method public void goForward();
method public void invokeZoomPicker();
method public boolean isPrivateBrowsingEnabled();
- method public void loadData(String, @Nullable String, @Nullable String);
- method public void loadDataWithBaseURL(@Nullable String, String, @Nullable String, @Nullable String, @Nullable String);
- method public void loadUrl(String, java.util.Map<java.lang.String,java.lang.String>);
- method public void loadUrl(String);
+ method public void loadData(@NonNull String, @Nullable String, @Nullable String);
+ method public void loadDataWithBaseURL(@Nullable String, @NonNull String, @Nullable String, @Nullable String, @Nullable String);
+ method public void loadUrl(@NonNull String, @NonNull java.util.Map<java.lang.String,java.lang.String>);
+ method public void loadUrl(@NonNull String);
method @Deprecated public void onChildViewAdded(android.view.View, android.view.View);
method @Deprecated public void onChildViewRemoved(android.view.View, android.view.View);
method @Deprecated public void onGlobalFocusChanged(android.view.View, android.view.View);
@@ -55233,23 +55233,23 @@
method public boolean pageDown(boolean);
method public boolean pageUp(boolean);
method public void pauseTimers();
- method public void postUrl(String, byte[]);
- method public void postVisualStateCallback(long, android.webkit.WebView.VisualStateCallback);
- method public void postWebMessage(android.webkit.WebMessage, android.net.Uri);
+ method public void postUrl(@NonNull String, @NonNull byte[]);
+ method public void postVisualStateCallback(long, @NonNull android.webkit.WebView.VisualStateCallback);
+ method public void postWebMessage(@NonNull android.webkit.WebMessage, @NonNull android.net.Uri);
method public void reload();
method public void removeJavascriptInterface(@NonNull String);
method public void requestFocusNodeHref(@Nullable android.os.Message);
- method public void requestImageRef(android.os.Message);
- method @Nullable public android.webkit.WebBackForwardList restoreState(android.os.Bundle);
+ method public void requestImageRef(@NonNull android.os.Message);
+ method @Nullable public android.webkit.WebBackForwardList restoreState(@NonNull android.os.Bundle);
method public void resumeTimers();
method @Deprecated public void savePassword(String, String, String);
- method @Nullable public android.webkit.WebBackForwardList saveState(android.os.Bundle);
- method public void saveWebArchive(String);
- method public void saveWebArchive(String, boolean, @Nullable android.webkit.ValueCallback<java.lang.String>);
+ method @Nullable public android.webkit.WebBackForwardList saveState(@NonNull android.os.Bundle);
+ method public void saveWebArchive(@NonNull String);
+ method public void saveWebArchive(@NonNull String, boolean, @Nullable android.webkit.ValueCallback<java.lang.String>);
method @Deprecated public void setCertificate(android.net.http.SslCertificate);
- method public static void setDataDirectorySuffix(String);
- method public void setDownloadListener(android.webkit.DownloadListener);
- method public void setFindListener(android.webkit.WebView.FindListener);
+ method public static void setDataDirectorySuffix(@NonNull String);
+ method public void setDownloadListener(@Nullable android.webkit.DownloadListener);
+ method public void setFindListener(@Nullable android.webkit.WebView.FindListener);
method @Deprecated public void setHorizontalScrollbarOverlay(boolean);
method @Deprecated public void setHttpAuthUsernamePassword(String, String, String, String);
method public void setInitialScale(int);
@@ -55260,9 +55260,9 @@
method public static void setSafeBrowsingWhitelist(@NonNull java.util.List<java.lang.String>, @Nullable android.webkit.ValueCallback<java.lang.Boolean>);
method public void setTextClassifier(@Nullable android.view.textclassifier.TextClassifier);
method @Deprecated public void setVerticalScrollbarOverlay(boolean);
- method public void setWebChromeClient(android.webkit.WebChromeClient);
+ method public void setWebChromeClient(@Nullable android.webkit.WebChromeClient);
method public static void setWebContentsDebuggingEnabled(boolean);
- method public void setWebViewClient(android.webkit.WebViewClient);
+ method public void setWebViewClient(@NonNull android.webkit.WebViewClient);
method public void setWebViewRenderProcessClient(@NonNull java.util.concurrent.Executor, @NonNull android.webkit.WebViewRenderProcessClient);
method public void setWebViewRenderProcessClient(@Nullable android.webkit.WebViewRenderProcessClient);
method @Deprecated public boolean shouldDelayChildPressedState();
@@ -55310,8 +55310,8 @@
public class WebView.WebViewTransport {
ctor public WebView.WebViewTransport();
- method public android.webkit.WebView getWebView();
- method public void setWebView(android.webkit.WebView);
+ method @Nullable public android.webkit.WebView getWebView();
+ method public void setWebView(@Nullable android.webkit.WebView);
}
public class WebViewClient {
diff --git a/core/java/android/webkit/WebView.java b/core/java/android/webkit/WebView.java
index 2af7ac7..4b47927 100644
--- a/core/java/android/webkit/WebView.java
+++ b/core/java/android/webkit/WebView.java
@@ -125,7 +125,7 @@
*
* @param webview the WebView to transport
*/
- public synchronized void setWebView(WebView webview) {
+ public synchronized void setWebView(@Nullable WebView webview) {
mWebview = webview;
}
@@ -134,6 +134,7 @@
*
* @return the transported WebView object
*/
+ @Nullable
public synchronized WebView getWebView() {
return mWebview;
}
@@ -309,7 +310,7 @@
*
* @param context an Activity Context to access application assets
*/
- public WebView(Context context) {
+ public WebView(@NonNull Context context) {
this(context, null);
}
@@ -319,7 +320,7 @@
* @param context an Activity Context to access application assets
* @param attrs an AttributeSet passed to our parent
*/
- public WebView(Context context, AttributeSet attrs) {
+ public WebView(@NonNull Context context, @Nullable AttributeSet attrs) {
this(context, attrs, com.android.internal.R.attr.webViewStyle);
}
@@ -332,7 +333,7 @@
* reference to a style resource that supplies default values for
* the view. Can be 0 to not look for defaults.
*/
- public WebView(Context context, AttributeSet attrs, int defStyleAttr) {
+ public WebView(@NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr) {
this(context, attrs, defStyleAttr, 0);
}
@@ -349,7 +350,8 @@
* defStyleAttr is 0 or can not be found in the theme. Can be 0
* to not look for defaults.
*/
- public WebView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) {
+ public WebView(@NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr,
+ int defStyleRes) {
this(context, attrs, defStyleAttr, defStyleRes, null, false);
}
@@ -370,7 +372,7 @@
* and {@link WebStorage} for fine-grained control of privacy data.
*/
@Deprecated
- public WebView(Context context, AttributeSet attrs, int defStyleAttr,
+ public WebView(@NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr,
boolean privateBrowsing) {
this(context, attrs, defStyleAttr, 0, null, privateBrowsing);
}
@@ -395,8 +397,8 @@
* be added synchronously, before a subsequent loadUrl call takes effect.
*/
@UnsupportedAppUsage
- protected WebView(Context context, AttributeSet attrs, int defStyleAttr,
- Map<String, Object> javaScriptInterfaces, boolean privateBrowsing) {
+ protected WebView(@NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr,
+ @Nullable Map<String, Object> javaScriptInterfaces, boolean privateBrowsing) {
this(context, attrs, defStyleAttr, 0, javaScriptInterfaces, privateBrowsing);
}
@@ -405,8 +407,9 @@
*/
@SuppressWarnings("deprecation") // for super() call into deprecated base class constructor.
@UnsupportedAppUsage
- protected WebView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes,
- Map<String, Object> javaScriptInterfaces, boolean privateBrowsing) {
+ protected WebView(@NonNull Context context, @Nullable AttributeSet attrs, int defStyleAttr,
+ int defStyleRes, @Nullable Map<String, Object> javaScriptInterfaces,
+ boolean privateBrowsing) {
super(context, attrs, defStyleAttr, defStyleRes);
// WebView is important by default, unless app developer overrode attribute.
@@ -642,7 +645,7 @@
* method fails.
*/
@Nullable
- public WebBackForwardList saveState(Bundle outState) {
+ public WebBackForwardList saveState(@NonNull Bundle outState) {
checkThread();
return mProvider.saveState(outState);
}
@@ -695,7 +698,7 @@
* @return the restored back/forward list or {@code null} if restoreState failed
*/
@Nullable
- public WebBackForwardList restoreState(Bundle inState) {
+ public WebBackForwardList restoreState(@NonNull Bundle inState) {
checkThread();
return mProvider.restoreState(inState);
}
@@ -713,7 +716,7 @@
* controlling caching, accept types or the User-Agent, their
* values may be overridden by this WebView's defaults.
*/
- public void loadUrl(String url, Map<String, String> additionalHttpHeaders) {
+ public void loadUrl(@NonNull String url, @NonNull Map<String, String> additionalHttpHeaders) {
checkThread();
mProvider.loadUrl(url, additionalHttpHeaders);
}
@@ -725,7 +728,7 @@
*
* @param url the URL of the resource to load
*/
- public void loadUrl(String url) {
+ public void loadUrl(@NonNull String url) {
checkThread();
mProvider.loadUrl(url);
}
@@ -739,7 +742,7 @@
* @param postData the data will be passed to "POST" request, which must be
* be "application/x-www-form-urlencoded" encoded.
*/
- public void postUrl(String url, byte[] postData) {
+ public void postUrl(@NonNull String url, @NonNull byte[] postData) {
checkThread();
if (URLUtil.isNetworkUrl(url)) {
mProvider.postUrl(url, postData);
@@ -803,7 +806,8 @@
* @param mimeType the MIME type of the data, e.g. 'text/html'.
* @param encoding the encoding of the data
*/
- public void loadData(String data, @Nullable String mimeType, @Nullable String encoding) {
+ public void loadData(@NonNull String data, @Nullable String mimeType,
+ @Nullable String encoding) {
checkThread();
mProvider.loadData(data, mimeType, encoding);
}
@@ -850,7 +854,7 @@
* @param historyUrl the URL to use as the history entry. If {@code null} defaults
* to 'about:blank'. If non-null, this must be a valid URL.
*/
- public void loadDataWithBaseURL(@Nullable String baseUrl, String data,
+ public void loadDataWithBaseURL(@Nullable String baseUrl, @NonNull String data,
@Nullable String mimeType, @Nullable String encoding, @Nullable String historyUrl) {
checkThread();
mProvider.loadDataWithBaseURL(baseUrl, data, mimeType, encoding, historyUrl);
@@ -873,7 +877,8 @@
* completes with the result of the execution (if any).
* May be {@code null} if no notification of the result is required.
*/
- public void evaluateJavascript(String script, @Nullable ValueCallback<String> resultCallback) {
+ public void evaluateJavascript(@NonNull String script, @Nullable ValueCallback<String>
+ resultCallback) {
checkThread();
mProvider.evaluateJavaScript(script, resultCallback);
}
@@ -883,7 +888,7 @@
*
* @param filename the filename where the archive should be placed
*/
- public void saveWebArchive(String filename) {
+ public void saveWebArchive(@NonNull String filename) {
checkThread();
mProvider.saveWebArchive(filename);
}
@@ -900,8 +905,8 @@
* under which the file was saved, or {@code null} if saving the
* file failed.
*/
- public void saveWebArchive(String basename, boolean autoname, @Nullable ValueCallback<String>
- callback) {
+ public void saveWebArchive(@NonNull String basename, boolean autoname,
+ @Nullable ValueCallback<String> callback) {
checkThread();
mProvider.saveWebArchive(basename, autoname, callback);
}
@@ -1064,7 +1069,7 @@
* requests with callbacks.
* @param callback The callback to be invoked.
*/
- public void postVisualStateCallback(long requestId, VisualStateCallback callback) {
+ public void postVisualStateCallback(long requestId, @NonNull VisualStateCallback callback) {
checkThread();
mProvider.insertVisualStateCallback(requestId, callback);
}
@@ -1131,7 +1136,8 @@
* @param documentName The user-facing name of the printed document. See
* {@link android.print.PrintDocumentInfo}
*/
- public PrintDocumentAdapter createPrintDocumentAdapter(String documentName) {
+ @NonNull
+ public PrintDocumentAdapter createPrintDocumentAdapter(@NonNull String documentName) {
checkThread();
return mProvider.createPrintDocumentAdapter(documentName);
}
@@ -1203,6 +1209,7 @@
* and the email is set in the "extra" field of HitTestResult. Otherwise,
* HitTestResult type is set to UNKNOWN_TYPE.
*/
+ @NonNull
public HitTestResult getHitTestResult() {
checkThread();
return mProvider.getHitTestResult();
@@ -1233,7 +1240,7 @@
* @param msg the message to be dispatched with the result of the request
* as the data member with "url" as key. The result can be {@code null}.
*/
- public void requestImageRef(Message msg) {
+ public void requestImageRef(@NonNull Message msg) {
checkThread();
mProvider.requestImageRef(msg);
}
@@ -1243,10 +1250,11 @@
* passed to WebViewClient.onPageStarted because although the load for
* that URL has begun, the current page may not have changed.
*
- * @return the URL for the current page
+ * @return the URL for the current page or {@code null} if no page has been loaded
*/
@InspectableProperty(hasAttributeId = false)
@ViewDebug.ExportedProperty(category = "webview")
+ @Nullable
public String getUrl() {
checkThread();
return mProvider.getUrl();
@@ -1259,10 +1267,12 @@
* Also, there may have been redirects resulting in a different URL to that
* originally requested.
*
- * @return the URL that was originally requested for the current page
+ * @return the URL that was originally requested for the current page or
+ * {@code null} if no page has been loaded
*/
@InspectableProperty(hasAttributeId = false)
@ViewDebug.ExportedProperty(category = "webview")
+ @Nullable
public String getOriginalUrl() {
checkThread();
return mProvider.getOriginalUrl();
@@ -1272,10 +1282,11 @@
* Gets the title for the current page. This is the title of the current page
* until WebViewClient.onReceivedTitle is called.
*
- * @return the title for the current page
+ * @return the title for the current page or {@code null} if no page has been loaded
*/
@InspectableProperty(hasAttributeId = false)
@ViewDebug.ExportedProperty(category = "webview")
+ @Nullable
public String getTitle() {
checkThread();
return mProvider.getTitle();
@@ -1285,9 +1296,11 @@
* Gets the favicon for the current page. This is the favicon of the current
* page until WebViewClient.onReceivedIcon is called.
*
- * @return the favicon for the current page
+ * @return the favicon for the current page or {@code null} if the page doesn't
+ * have one or if no page has been loaded
*/
@InspectableProperty(hasAttributeId = false)
+ @Nullable
public Bitmap getFavicon() {
checkThread();
return mProvider.getFavicon();
@@ -1523,6 +1536,7 @@
* different objects. The object returned from this method will not be
* updated to reflect any new state.
*/
+ @NonNull
public WebBackForwardList copyBackForwardList() {
checkThread();
return mProvider.copyBackForwardList();
@@ -1535,7 +1549,7 @@
*
* @param listener an implementation of {@link FindListener}
*/
- public void setFindListener(FindListener listener) {
+ public void setFindListener(@Nullable FindListener listener) {
checkThread();
setupFindListenerIfNeeded();
mFindListener.mUserFindListener = listener;
@@ -1580,7 +1594,7 @@
* @param find the string to find.
* @see #setFindListener
*/
- public void findAllAsync(String find) {
+ public void findAllAsync(@NonNull String find) {
checkThread();
mProvider.findAllAsync(find);
}
@@ -1682,7 +1696,7 @@
*
* @param response the message that will be dispatched with the result
*/
- public void documentHasImages(Message response) {
+ public void documentHasImages(@NonNull Message response) {
checkThread();
mProvider.documentHasImages(response);
}
@@ -1694,7 +1708,7 @@
* @param client an implementation of WebViewClient
* @see #getWebViewClient
*/
- public void setWebViewClient(WebViewClient client) {
+ public void setWebViewClient(@NonNull WebViewClient client) {
checkThread();
mProvider.setWebViewClient(client);
}
@@ -1705,6 +1719,7 @@
* @return the WebViewClient, or a default client if not yet set
* @see #setWebViewClient
*/
+ @NonNull
public WebViewClient getWebViewClient() {
checkThread();
return mProvider.getWebViewClient();
@@ -1798,7 +1813,7 @@
*
* @param listener an implementation of DownloadListener
*/
- public void setDownloadListener(DownloadListener listener) {
+ public void setDownloadListener(@Nullable DownloadListener listener) {
checkThread();
mProvider.setDownloadListener(listener);
}
@@ -1811,7 +1826,7 @@
* @param client an implementation of WebChromeClient
* @see #getWebChromeClient
*/
- public void setWebChromeClient(WebChromeClient client) {
+ public void setWebChromeClient(@Nullable WebChromeClient client) {
checkThread();
mProvider.setWebChromeClient(client);
}
@@ -1898,7 +1913,7 @@
* context. {@code null} values are ignored.
* @param name the name used to expose the object in JavaScript
*/
- public void addJavascriptInterface(Object object, String name) {
+ public void addJavascriptInterface(@NonNull Object object, @NonNull String name) {
checkThread();
mProvider.addJavascriptInterface(object, name);
}
@@ -1926,6 +1941,7 @@
*
* @return the two message ports that form the message channel.
*/
+ @NonNull
public WebMessagePort[] createWebMessageChannel() {
checkThread();
return mProvider.createWebMessageChannel();
@@ -1950,7 +1966,7 @@
* @param message the WebMessage
* @param targetOrigin the target origin.
*/
- public void postWebMessage(WebMessage message, Uri targetOrigin) {
+ public void postWebMessage(@NonNull WebMessage message, @NonNull Uri targetOrigin) {
checkThread();
mProvider.postMessageToMainFrame(message, targetOrigin);
}
@@ -1962,6 +1978,7 @@
* @return a WebSettings object that can be used to control this WebView's
* settings
*/
+ @NonNull
public WebSettings getSettings() {
checkThread();
return mProvider.getSettings();
@@ -2026,7 +2043,7 @@
* in the current process.
* @throws IllegalArgumentException if the suffix contains a path separator.
*/
- public static void setDataDirectorySuffix(String suffix) {
+ public static void setDataDirectorySuffix(@NonNull String suffix) {
WebViewFactory.setDataDirectorySuffix(suffix);
}