Package com.bumptech.glide.load.model

Class LazyHeaders.Builder

java.lang.Object

com.bumptech.glide.load.model.LazyHeaders.Builder

Enclosing class:

LazyHeaders

public static final class LazyHeaders.Builder
extends java.lang.Object

Adds an LazyHeaderFactory that will be used to construct a value for the given key* lazily on a background thread.

This class is not thread safe.

This class may include default values for User-Agent and Accept-Encoding headers. These will be replaced by calls to either setHeader(String, LazyHeaderFactory) or addHeader(String, String), even though addHeader(String, LazyHeaderFactory) would usually append an additional value.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
LazyHeaders.Builder	addHeader(java.lang.String key, LazyHeaderFactory factory)	Adds an LazyHeaderFactory that will be used to construct a value for the given key lazily on a background thread.
LazyHeaders.Builder	addHeader(java.lang.String key, java.lang.String value)	Adds a value for the given header and returns this builder.
LazyHeaders	build()	Returns a new immutable LazyHeaders object.
LazyHeaders.Builder	setHeader(java.lang.String key, LazyHeaderFactory factory)	Replaces all existing LazyHeaderFactorys for the given key with the given LazyHeaderFactory.
LazyHeaders.Builder	setHeader(java.lang.String key, java.lang.String value)	Replaces all existing LazyHeaderFactorys for the given key with the given LazyHeaderFactory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

addHeader

public LazyHeaders.Builder addHeader(@NonNull
                                     java.lang.String key,
                                     @NonNull
                                     java.lang.String value)

Adds a value for the given header and returns this builder.

Use addHeader(String, LazyHeaderFactory) if obtaining the value requires I/O (i.e. an OAuth token).

See Also:

addHeader(String, LazyHeaderFactory)

addHeader

public LazyHeaders.Builder addHeader(@NonNull
                                     java.lang.String key,
                                     @NonNull
                                     LazyHeaderFactory factory)

Adds an LazyHeaderFactory that will be used to construct a value for the given key lazily on a background thread.

Headers may have multiple values whose order is defined by the order in which this method is called.

This class does not prevent you from adding the same value to a given key multiple times

setHeader

public LazyHeaders.Builder setHeader(@NonNull
                                     java.lang.String key,
                                     @Nullable
                                     java.lang.String value)

Replaces all existing LazyHeaderFactorys for the given key with the given LazyHeaderFactory.

If the given value is null, the header at the given key will be removed.

Use setHeader(String, LazyHeaderFactory) if obtaining the value requires I/O (i.e. an OAuth token).

setHeader

public LazyHeaders.Builder setHeader(@NonNull
                                     java.lang.String key,
                                     @Nullable
                                     LazyHeaderFactory factory)

Replaces all existing LazyHeaderFactorys for the given key with the given LazyHeaderFactory.

If the given value is null, the header at the given key will be removed.

build

public LazyHeaders build()

Returns a new immutable LazyHeaders object.