1
    2
    3
    4
    5
    6
    7
    8
    9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
   70
   71
   72
   73
   74
   75
   76
   77
   78
   79
   80
   81
   82
   83
   84
   85
   86
   87
   88
   89
   90
   91
   92
   93
   94
   95
   96
   97
   98
   99
  100
  101
  102
  103
  104
  105
  106
  107
  108
  109
  110
  111
  112
  113
  114
  115
  116
  117
  118
  119
  120
  121
  122
  123
  124
  125
  126
  127


content / public / android / java / src / org / chromium / content_public / browser / NavigationEntry.java [blame]

// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package org.chromium.content_public.browser;

import android.graphics.Bitmap;

import androidx.annotation.NonNull;

import org.chromium.url.GURL;

/** Represents one entry in the navigation history of a page. */
public class NavigationEntry {

    private final int mIndex;
    private final GURL mUrl;
    private final GURL mOriginalUrl;
    private final GURL mVirtualUrl;
    private final String mTitle;
    private Bitmap mFavicon;
    private int mTransition;
    private long mTimestamp;
    private final boolean mIsInitialEntry;

    /** Default constructor. */
    public NavigationEntry(
            int index,
            @NonNull GURL url,
            @NonNull GURL virtualUrl,
            @NonNull GURL originalUrl,
            String title,
            Bitmap favicon,
            int transition,
            long timestamp,
            boolean isInitialEntry) {
        mIndex = index;
        mUrl = url;
        mVirtualUrl = virtualUrl;
        mOriginalUrl = originalUrl;
        mTitle = title;
        mFavicon = favicon;
        mTransition = transition;
        mTimestamp = timestamp;
        mIsInitialEntry = isInitialEntry;
    }

    /**
     * @return The index into the navigation history that this entry represents.
     */
    public int getIndex() {
        return mIndex;
    }

    /**
     * @return The actual URL of the page. For some about pages, this may be a
     *         scary data: URL or something like that. Use GetVirtualURL() for
     *         showing to the user.
     */
    public @NonNull GURL getUrl() {
        return mUrl;
    }

    /**
     * @return The virtual URL, when nonempty, will override the actual URL of
     *         the page when we display it to the user. This allows us to have
     *         nice and friendly URLs that the user sees for things like about:
     *         URLs, but actually feed the renderer a data URL that results in
     *         the content loading.
     *         <p/>
     *         GetVirtualURL() will return the URL to display to the user in all
     *         cases, so if there is no overridden display URL, it will return
     *         the actual one.
     */
    public @NonNull GURL getVirtualUrl() {
        return mVirtualUrl;
    }

    /**
     * @return The URL that caused this NavigationEntry to be created.
     */
    public @NonNull GURL getOriginalUrl() {
        return mOriginalUrl;
    }

    /**
     * @return The title as set by the page. This will be empty if there is no
     *         title set. The caller is responsible for detecting when there is
     *         no title and displaying the appropriate "Untitled" label if this
     *         is being displayed to the user.
     */
    public String getTitle() {
        return mTitle;
    }

    /**
     * @return The favicon of the page. This may be null.
     */
    public Bitmap getFavicon() {
        return mFavicon;
    }

    /**
     * @param favicon The updated favicon to replace the existing one with.
     */
    public void updateFavicon(Bitmap favicon) {
        mFavicon = favicon;
    }

    public int getTransition() {
        return mTransition;
    }

    /**
     * @return The Timestamp when the last navigation completed.
     */
    public long getTimestamp() {
        return mTimestamp;
    }

    /**
     * @return Whether the entry is the initial entry or not.
     */
    public boolean isInitialEntry() {
        return mIsInitialEntry;
    }
}