WebResourceError.java revision 25e89545736d62c59d19dd9b9587f7b0cbbee068
1/*
2 * Copyright (C) 2015 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.webkit;
18
19/**
20 * Encapsulates information about errors occured during loading of web resources. See
21 * {@link WebViewClient#onReceivedError(WebView, WebResourceRequest, WebResourceError) WebViewClient.onReceivedError(WebView, WebResourceRequest, WebResourceError)}
22 */
23public abstract class WebResourceError {
24    /**
25     * Gets the error code of the error. The code corresponds to one
26     * of the ERROR_* constants in {@link WebViewClient}.
27     *
28     * @return The error code of the error
29     */
30    public abstract int getErrorCode();
31
32    /**
33     * Gets the string describing the error. Descriptions are localized,
34     * and thus can be used for communicating the problem to the user.
35     *
36     * @return The description of the error
37     */
38    public abstract String getDescription();
39}
40