retrofit.http.QueryMap Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dwolla-plugin Show documentation
Kill Bill Dwolla plugin
The newest version!
/*
 * Copyright (C) 2014 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 retrofit.http;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

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

/**
 * Query parameter keys and values appended to the URL.
 * 
 * Both keys and values are converted to strings using {@link String#valueOf(Object)}. Values are
 * URL encoded and {@code null} will not include the query parameter in the URL. {@code null} keys
 * are not allowed.
 * 

 * Simple Example:
 * 
 * @GET("/search")
 * void list(@QueryMap Map<String, String> filters);
 * 
 * Calling with {@code foo.list(ImmutableMap.of("foo", "bar", "kit", "kat"))} yields
 * {@code /search?foo=bar&kit=kat}.
 * 
 * Map keys representing the parameter names are not URL encoded. Specify
 * {@link #encodeNames() encodeNames=true} to change this behavior.
 * 
 * @GET("/search")
 * void list(@QueryMap(encodeNames=true) Map<String, String> filters);
 * 
 * Calling with {@code foo.list(ImmutableMap.of("foo+bar", "foo+bar"))} yields
 * {@code /search?foo%2Bbar=foo}.
 * 
 * Map values representing parameter values are URL encoded by default. Specify
 * {@link #encodeValues() encodeValues=false} to change this behavior.
 * 
 * @GET("/search")
 * void list(@QueryMap(encodeValues=false) Map<String, String> filters);
 * 
 * Calling with {@code foo.list(ImmutableMap.of("foo", "foo+foo"))} yields
 * {@code /search?foo=foo%2Bbar}.
 *
 * @see Query
 */
@Documented
@Target(PARAMETER)
@Retention(RUNTIME)
public @interface QueryMap {
  /** Specifies whether parameter names (keys in the map) are URL encoded. */
  boolean encodeNames() default false;

  /** Specifies whether parameter values (values in the map) are URL encoded. */
  boolean encodeValues() default true;
}