feign.template

Class QueryTemplate

java.lang.Object

feign.template.QueryTemplate

public final class QueryTemplate
extends Object

Template for a Query String parameter.

Method Summary

Modifier and Type	Method and Description
static QueryTemplate	append(QueryTemplate queryTemplate, Iterable<String> values, CollectionFormat collectionFormat, boolean decodeSlash) Append a value to the Query Template.
static QueryTemplate	create(String name, Iterable<String> values, Charset charset) Create a new Query Template.
static QueryTemplate	create(String name, Iterable<String> values, Charset charset, CollectionFormat collectionFormat)
static QueryTemplate	create(String name, Iterable<String> values, Charset charset, CollectionFormat collectionFormat, boolean decodeSlash) Create a new Query Template.
String	expand(Map<String,?> variables) Expand this template.
String	getName()
List<String>	getValues()
List<String>	getVariables()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static QueryTemplate create(String name,
                                   Iterable<String> values,
                                   Charset charset)

Create a new Query Template.

Parameters:

name - of the query parameter.

values - in the template.

charset - for the template.

Returns:

a QueryTemplate.

create

public static QueryTemplate create(String name,
                                   Iterable<String> values,
                                   Charset charset,
                                   CollectionFormat collectionFormat)

create

public static QueryTemplate create(String name,
                                   Iterable<String> values,
                                   Charset charset,
                                   CollectionFormat collectionFormat,
                                   boolean decodeSlash)

Create a new Query Template.

Parameters:

name - of the query parameter.

values - in the template.

charset - for the template.

collectionFormat - to use.

decodeSlash - if slash characters should be decoded

Returns:

a QueryTemplate

append

public static QueryTemplate append(QueryTemplate queryTemplate,
                                   Iterable<String> values,
                                   CollectionFormat collectionFormat,
                                   boolean decodeSlash)

Append a value to the Query Template.

Parameters:

queryTemplate - to append to.

values - to append.

Returns:

a new QueryTemplate with value appended.

getValues

public List<String> getValues()

getVariables

public List<String> getVariables()

getName

public String getName()

toString

public String toString()

Overrides:

toString in class Object

expand

public String expand(Map<String,?> variables)

Expand this template. Unresolved variables are removed. If all values remain unresolved, the result is an empty string.

Parameters:

variables - containing the values for expansion.

Returns:

the expanded template.