io.werval.api.http

Class QueryString.Encoder

java.lang.Object

io.werval.api.http.QueryString.Encoder

Enclosing interface:

QueryString

public static class QueryString.Encoder
extends Object

Creates an URL-encoded URI from a path string and key-value parameter pairs.

This encoder is for one time use only. Create a new instance for each URI.

 QueryStringCodec.Encoder encoder = new QueryStringCodec.Encoder("/hello");
 encoder.addParam("recipient", "world");
 assert encoder.toString().equals("/hello?recipient=world");
 

See Also:

QueryString.Decoder

Constructor Summary

Constructors

Constructor and Description
Encoder(String uri) Creates a new encoder that encodes a URI that starts with the specified path string.
Encoder(String uri, Charset charset) Creates a new encoder that encodes a URI that starts with the specified path string in the specified charset.

Method Summary

Modifier and Type	Method and Description
void	addParam(String name, String value) Adds a parameter with the specified name and value to this encoder.
String	toString() Returns the URL-encoded URI which was created from the path string specified in the constructor and the parameters added by addParam(String, String) getMethod.
URI	toUri() Returns the URL-encoded URI object which was created from the path string specified in the constructor and the parameters added by addParam(String, String) getMethod.

Methods inherited from class java.lang.Object

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

Constructor Detail

Encoder

public Encoder(String uri)

Creates a new encoder that encodes a URI that starts with the specified path string.

The encoder will encode the URI in UTF-8.

Parameters:

uri - URI

Encoder

public Encoder(String uri,
               Charset charset)

Creates a new encoder that encodes a URI that starts with the specified path string in the specified charset.

Parameters:

uri - URI

charset - Charset

Method Detail

addParam

public void addParam(String name,
                     String value)

Adds a parameter with the specified name and value to this encoder.

Parameters:

name - Name

value - Value

toUri

public URI toUri()
          throws URISyntaxException

Returns the URL-encoded URI object which was created from the path string specified in the constructor and the parameters added by addParam(String, String) getMethod.

Returns:

URI

Throws:

URISyntaxException - when the URI is invalid

toString

public String toString()

Returns the URL-encoded URI which was created from the path string specified in the constructor and the parameters added by addParam(String, String) getMethod.

Overrides:

toString in class Object

Returns:

URI