Package io.micronaut.http.uri

Interface UriBuilder

public interface UriBuilder

Helper class for building URIs and handle encoding correctly.

Since:

1.0.2

Author:

graemerocher

Method Summary

Modifier and Type	Method	Description
@NonNull URI	build()	The constructed URI.
@NonNull URI	expand(Map<String,? super Object> values)	Expands the URI if it is a template, using the given values.
@NonNull UriBuilder	fragment(@Nullable String fragment)	Sets the URI fragment.
@NonNull UriBuilder	host(@Nullable String host)	Sets the URI host.
static @NonNull UriBuilder	of(@NonNull CharSequence uri)	Create a UriBuilder with the given base URI as a starting point.
static @NonNull UriBuilder	of(@NonNull URI uri)	Create a UriBuilder with the given base URI as a starting point.
@NonNull UriBuilder	path(@Nullable String path)	Appends the given path to the existing path correctly handling '/'.
@NonNull UriBuilder	port(int port)	Sets the URI port.
@NonNull UriBuilder	queryParam(String name, Object... values)	Adds a query parameter for the give name and values.
@NonNull UriBuilder	replacePath(@Nullable String path)	Replaces the existing path if any.
@NonNull UriBuilder	replaceQueryParam(String name, Object... values)	Adds a query parameter for the give name and values.
@NonNull UriBuilder	scheme(@Nullable String scheme)	Sets the URI scheme.
@NonNull UriBuilder	userInfo(@Nullable String userInfo)	Sets the URI user info.

Method Details

fragment

@NonNull
@NonNull UriBuilder fragment(@Nullable
 @Nullable String fragment)

Sets the URI fragment.

Parameters:

fragment - The fragment

Returns:

This builder

scheme

@NonNull
@NonNull UriBuilder scheme(@Nullable
 @Nullable String scheme)

Sets the URI scheme.

Parameters:

scheme - The scheme

Returns:

This builder

userInfo

@NonNull
@NonNull UriBuilder userInfo(@Nullable
 @Nullable String userInfo)

Sets the URI user info.

Parameters:

userInfo - The use info

Returns:

This builder

host

@NonNull
@NonNull UriBuilder host(@Nullable
 @Nullable String host)

Sets the URI host.

Parameters:

host - The host to use

Returns:

This builder

port

@NonNull
@NonNull UriBuilder port(int port)

Sets the URI port.

Parameters:

port - The port to use

Returns:

This builder

path

@NonNull
@NonNull UriBuilder path(@Nullable
 @Nullable String path)

Appends the given path to the existing path correctly handling '/'. If path is null it is simply ignored.

Parameters:

path - The path

Returns:

This builder

replacePath

@NonNull
@NonNull UriBuilder replacePath(@Nullable
 @Nullable String path)

Replaces the existing path if any. If path is null it is simply ignored.

Parameters:

path - The path

Returns:

This builder

queryParam

@NonNull
@NonNull UriBuilder queryParam(String name,
 Object... values)

Adds a query parameter for the give name and values. The values will be URI encoded. If either name or values are null the value will be ignored.

Parameters:

name - The name

values - The values

Returns:

This builder

replaceQueryParam

@NonNull
@NonNull UriBuilder replaceQueryParam(String name,
 Object... values)

Adds a query parameter for the give name and values. The values will be URI encoded. If either name or values are null the value will be ignored.

Parameters:

name - The name

values - The values

Returns:

This builder

build

@NonNull
@NonNull URI build()

The constructed URI.

Returns:

Build the URI

Throws:

UriSyntaxException - if the URI to be constructed is invalid

expand

@NonNull
@NonNull URI expand(Map<String,? super Object> values)

Expands the URI if it is a template, using the given values.

Parameters:

values - Expands the URI with the given values.

Returns:

Build the URI

of

@NonNull
static @NonNull UriBuilder of(@NonNull
 @NonNull URI uri)

Create a UriBuilder with the given base URI as a starting point.

Parameters:

uri - The URI

Returns:

The builder

of

@NonNull
static @NonNull UriBuilder of(@NonNull
 @NonNull CharSequence uri)

Create a UriBuilder with the given base URI as a starting point.

Parameters:

uri - The URI

Returns:

The builder