com.jcabi.http

Interface RequestURI

@Immutable
public interface RequestURI

Request URI.

Instance of this interface is returned by Request.uri(), and can be modified using one of the methods below. When modification is done, method back() returns a modified instance of Request, for example:

 new JdkRequest("http://my.example.com")
   .header("Accept", "application/json")
   .uri()
   .path("/users")
   .queryParam("name", "Jeff Lebowski")
   .back() // returns a modified instance of Request
   .fetch()

Instances of this interface are immutable and thread-safe.

Since:

0.8

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Method Summary

Methods

Modifier and Type	Method and Description
Request	back() Get back to the request it's related to.
URI	get() Get URI.
RequestURI	path(String segment) Add URI path.
RequestURI	port(int num) Set port number.
RequestURI	queryParam(String name, Object value) Add query param.
RequestURI	queryParams(Map<String,String> map) Add query params.
RequestURI	set(URI uri) Set URI.
RequestURI	userInfo(String info) Set user info.

Method Detail

back

@NotNull(message="request is never NULL")
Request back()

Get back to the request it's related to.

Returns:

The request we're in

get

@NotNull(message="URI is never NULL")
URI get()

Get URI.

Returns:

The destination it is currently pointing to

set

@NotNull(message="URI is never NULL")
RequestURI set(@NotNull(message="URI can\'t be NULL")
                            URI uri)

Set URI.

Parameters:

uri - URI to set

Returns:

New alternated URI

queryParam

@NotNull(message="request URI is never NULL")
RequestURI queryParam(@NotNull(message="query param name can\'t be NULL")
                                   String name,
                                   @NotNull(message="query param value can\'t be NULL")
                                   Object value)

Add query param.

Parameters:

name - Query param name

value - Value of the query param to set

Returns:

New alternated URI

queryParams

@NotNull(message="request URI is never NULL")
RequestURI queryParams(@NotNull(message="map of params can\'t be NULL")
                                    Map<String,String> map)

Add query params.

Parameters:

map - Map of params to add

Returns:

New alternated URI

path

@NotNull(message="request URI is never NULL")
RequestURI path(@NotNull(message="path can\'t be NULL")
                             String segment)

Add URI path.

Parameters:

segment - Path segment to add

Returns:

New alternated URI

userInfo

@NotNull(message="new request URI is never NULL")
RequestURI userInfo(@NotNull(message="info can\'t be NULL")
                                 String info)

Set user info.

Parameters:

info - User info part to set

Returns:

New alternated URI

port

@NotNull(message="new request URI is never NULL")
RequestURI port(int num)

Set port number.

Parameters:

num - The port number to set

Returns:

New altered URI