Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 5b0a3215 authored by Torne (Richard Coles)'s avatar Torne (Richard Coles)
Browse files

Clarify WebResourceResponse's stream handling. 

Explicitly state in the documentation that the WebView will call
InputStream.close() after it's finished reading the response from a
WebResourceResponse.

Fixes: 122665050
Test: m offline-sdk-docs
Change-Id: I933c58e335ff1af31db6b4f959316ee389359e01
parent b9596e5f

core/java/android/webkit/WebResourceResponse.java

+9 −7
Original line number Diff line number Diff line
@@ -39,9 +39,9 @@ public class WebResourceResponse { 


    /**

     * Constructs a resource response with the given MIME type, character encoding,

     * and input stream. Callers must implement

     * {@link InputStream#read(byte[]) InputStream.read(byte[])} for the input

     * stream.

     * and input stream. Callers must implement {@link InputStream#read(byte[])} for

     * the input stream. {@link InputStream#close()} will be called after the WebView

     * has finished with the response.

     *

     * <p class="note"><b>Note:</b> The MIME type and character encoding must

     * be specified as separate parameters (for example {@code "text/html"} and
@@ -64,9 +64,10 @@ public class WebResourceResponse { 
    }



    /**

     * Constructs a resource response with the given parameters. Callers must

     * implement {@link InputStream#read(byte[]) InputStream.read(byte[])} for

     * the input stream.

     * Constructs a resource response with the given parameters. Callers must implement

     * {@link InputStream#read(byte[])} for the input stream. {@link InputStream#close()} will be

     * called after the WebView has finished with the response.

     *

     *

     * <p class="note"><b>Note:</b> See {@link #WebResourceResponse(String,String,InputStream)}

     * for details on what should be specified for {@code mimeType} and {@code encoding}.
@@ -198,7 +199,8 @@ public class WebResourceResponse { 


    /**

     * Sets the input stream that provides the resource response's data. Callers

     * must implement {@link InputStream#read(byte[]) InputStream.read(byte[])}.

     * must implement {@link InputStream#read(byte[])}. {@link InputStream#close()}

     * will be called after the WebView has finished with the response.

     *

     * @param data the input stream that provides the resource response's data. Must not be a

     *             StringBufferInputStream.