blob: d9fd9ec5af64ec11c2e969be4b46f9fac882069a (
plain)
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
|
/* -*- Mode: Java; c-basic-offset: 4; tab-width: 4; indent-tabs-mode: nil; -*-
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
package org.mozilla.gecko.icons;
import android.content.Context;
import android.support.annotation.CheckResult;
import org.mozilla.gecko.GeckoAppShell;
import ch.boye.httpclientandroidlib.util.TextUtils;
/**
* Builder for creating a request to load an icon.
*/
public class IconRequestBuilder {
private final IconRequest request;
/* package-private */ IconRequestBuilder(Context context) {
this(new IconRequest(context));
}
/* package-private */ IconRequestBuilder(IconRequest request) {
this.request = request;
}
/**
* Set the URL of the page for which the icon should be loaded.
*/
@CheckResult
public IconRequestBuilder pageUrl(String pageUrl) {
request.pageUrl = pageUrl;
return this;
}
/**
* Set whether this request is allowed to load icons from non http(s) URLs (e.g. the omni.ja).
*
* For example web content referencing internal URLs should not lead to us loading icons from
* internal data structures like the omni.ja.
*/
@CheckResult
public IconRequestBuilder privileged(boolean privileged) {
request.privileged = privileged;
return this;
}
/**
* Add an icon descriptor describing the location and properties of an icon. All descriptors
* will be ranked and tried in order of their rank. Executing the request will modify the list
* of icons (filter or add additional descriptors).
*/
@CheckResult
public IconRequestBuilder icon(IconDescriptor descriptor) {
request.icons.add(descriptor);
return this;
}
/**
* Skip the network and do not load an icon from a network connection.
*/
@CheckResult
public IconRequestBuilder skipNetwork() {
request.skipNetwork = true;
return this;
}
/**
* Skip the disk cache and do not load an icon from disk.
*/
@CheckResult
public IconRequestBuilder skipDisk() {
request.skipDisk = true;
return this;
}
/**
* Skip the memory cache and do not return a previously loaded icon.
*/
@CheckResult
public IconRequestBuilder skipMemory() {
request.skipMemory = true;
return this;
}
/**
* The icon will be used as (Android) launcher icon. The loaded icon will be scaled to the
* preferred Android launcher icon size.
*/
public IconRequestBuilder forLauncherIcon() {
request.targetSize = GeckoAppShell.getPreferredIconSize();
return this;
}
/**
* Execute the callback on the background thread. By default the callback is always executed on
* the UI thread in order to add the loaded icon to a view easily.
*/
@CheckResult
public IconRequestBuilder executeCallbackOnBackgroundThread() {
request.backgroundThread = true;
return this;
}
/**
* When executing the request then only prepare executing it but do not actually load an icon.
* This mode is only used for some legacy code that uses the icon URL and therefore needs to
* perform a lookup of the URL but doesn't want to load the icon yet.
*/
public IconRequestBuilder prepareOnly() {
request.prepareOnly = true;
return this;
}
/**
* Return the request built with this builder.
*/
@CheckResult
public IconRequest build() {
if (TextUtils.isEmpty(request.pageUrl)) {
throw new IllegalStateException("Page URL is required");
}
return request;
}
/**
* This is a no-op method.
*
* All builder methods are annotated with @CheckResult to denote that the
* methods return the builder object and that it is typically an error to not call another method
* on it until eventually calling build().
*
* However in some situations code can keep a reference
* to the builder object and call methods only when a specific event occurs. To make this explicit
* and avoid lint errors this method can be called.
*/
public void deferBuild() {
// No op
}
}
|
