retrofit2.http.HeaderMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of retrofit Show documentation

A type-safe HTTP client for Android and Java.

There is a newer version: 2.11.0

/*
 * Copyright (C) 2016 Square, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package retrofit2.http;

import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.lang.reflect.Type;
import java.util.Map;
import retrofit2.Retrofit;

/**
 * Adds headers specified in the {@link Map} or {@link okhttp3.Headers}.
 *
 * Values in the map are converted to strings using {@link Retrofit#stringConverter(Type,
 * Annotation[])} (or {@link Object#toString()}, if no matching string converter is installed).
 *
 * 
Simple Example:
 *
 * 
 * @GET("/search")
 * void list(@HeaderMap Map<String, String> headers);
 *
 * ...
 *
 * // The following call yields /search with headers
 * // Accept: text/plain and Accept-Charset: utf-8
 * foo.list(ImmutableMap.of("Accept", "text/plain", "Accept-Charset", "utf-8"));
 * 
 *
 * @see Header
 * @see Headers
 */
@Documented
@Target(PARAMETER)
@Retention(RUNTIME)
public @interface HeaderMap {}