com.bumptech.glide.load.model.Headers Maven / Gradle / Ivy

package com.bumptech.glide.load.model;

import java.util.Collections;
import java.util.Map;

/**
 * An interface for a wrapper for a set of headers to be included in a Glide request.
 * Implementations must implement equals() and hashcode().
 */
public interface Headers {

    /**
     * An empty Headers object that can be used if users don't want to provide headers.
     *
     * @deprecated Use {@link #DEFAULT} instead.
     */
    @Deprecated
    Headers NONE = new Headers() {
        @Override
        public Map getHeaders() {
            return Collections.emptyMap();
        }
    };

    /**
     * A Headers object containing reasonable defaults that should be used when users don't want
     * to provide their own headers.
     */
    Headers DEFAULT = new LazyHeaders.Builder().build();

    Map getHeaders();

}