WebHistoryItem.java revision 3442c74d2ce220a2d104a5717994bbaf09a9f02d
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.webkit; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 193442c74d2ce220a2d104a5717994bbaf09a9f02dNate Fischerimport android.annotation.Nullable; 20451e338c51e8c45efc0d21536dfae6f78f6d5e06Ignacio Sollaimport android.annotation.SystemApi; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.graphics.Bitmap; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * A convenience class for accessing fields in an entry in the back/forward list 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * of a WebView. Each WebHistoryItem is a snapshot of the requested history 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * item. Each history item may be updated during the load of a page. 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see WebBackForwardList 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 29451e338c51e8c45efc0d21536dfae6f78f6d5e06Ignacio Sollapublic abstract class WebHistoryItem implements Cloneable { 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return an identifier for this history item. If an item is a copy of 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * another item, the identifiers will be the same even if they are not the 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * same object. 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The id for this item. 35fc77165d446520716f18cdc14e30b39a6d8b9bacKristian Monsen * @deprecated This method is now obsolete. 36f4912580e6adc90ab37b07b8108c7334f359e317Kristian Monsen * @hide Since API level {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1} 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 38451e338c51e8c45efc0d21536dfae6f78f6d5e06Ignacio Solla @SystemApi 39fc77165d446520716f18cdc14e30b39a6d8b9bacKristian Monsen @Deprecated 40451e338c51e8c45efc0d21536dfae6f78f6d5e06Ignacio Solla public abstract int getId(); 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the url of this history item. The url is the base url of this 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * history item. See getTargetUrl() for the url that is the actual target of 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this history item. 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The base url of this history item. 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Note: The VM ensures 32-bit atomic read/write operations so we don't have 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to synchronize this method. 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 50451e338c51e8c45efc0d21536dfae6f78f6d5e06Ignacio Solla public abstract String getUrl(); 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the original url of this history item. This was the requested 54451e338c51e8c45efc0d21536dfae6f78f6d5e06Ignacio Solla * url, the final url may be different as there might have been 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * redirects while loading the site. 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The original url of this history item. 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 58451e338c51e8c45efc0d21536dfae6f78f6d5e06Ignacio Solla public abstract String getOriginalUrl(); 59451e338c51e8c45efc0d21536dfae6f78f6d5e06Ignacio Solla 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the document title of this history item. 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The document title of this history item. 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Note: The VM ensures 32-bit atomic read/write operations so we don't have 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to synchronize this method. 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 66451e338c51e8c45efc0d21536dfae6f78f6d5e06Ignacio Solla public abstract String getTitle(); 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 690a6140d2173052b4fa753c9ea61f92814cbced6eNate Fischer * Return the favicon of this history item or {@code null} if no favicon was found. 700a6140d2173052b4fa753c9ea61f92814cbced6eNate Fischer * @return A Bitmap containing the favicon for this history item or {@code null}. 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Note: The VM ensures 32-bit atomic read/write operations so we don't have 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to synchronize this method. 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 743442c74d2ce220a2d104a5717994bbaf09a9f02dNate Fischer @Nullable 75451e338c51e8c45efc0d21536dfae6f78f6d5e06Ignacio Solla public abstract Bitmap getFavicon(); 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Clone the history item for use by clients of WebView. 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 80451e338c51e8c45efc0d21536dfae6f78f6d5e06Ignacio Solla protected abstract WebHistoryItem clone(); 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 82