Package io.wcm.sling.commons.request

Class QueryStringBuilder

java.lang.Object

io.wcm.sling.commons.request.QueryStringBuilder

@ProviderType
public final class QueryStringBuilder
extends Object

Builds a property URL-encoded query string.

Constructor Summary

Constructors

Constructor	Description
QueryStringBuilder()

Method Summary

Modifier and Type	Method	Description
@Nullable String	build()	Build query string.
@NotNull QueryStringBuilder	param(@NotNull String name, @Nullable Object value)	Add parameter to query string.
@NotNull QueryStringBuilder	params(@NotNull Map<String,Object> values)	Add map of parameters to query string.

Methods inherited from class java.lang.Object

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

Constructor Details

QueryStringBuilder

public QueryStringBuilder()

Method Details

param

@NotNull
public @NotNull QueryStringBuilder param(@NotNull
 @NotNull String name,
 @Nullable
 @Nullable Object value)

Add parameter to query string.

Parameters:

name - Parameter name

value - Parameter value. Will be converted to string. If value is an array or Iterable the value items will be added as separate parameters.

Returns:

this

params

@NotNull
public @NotNull QueryStringBuilder params(@NotNull
 @NotNull Map<String,Object> values)

Add map of parameters to query string.

Parameters:

values - Map with parameter names and values. Values will be converted to strings. If a value is an array or Iterable the value items will be added as separate parameters.

Returns:

this

build

@Nullable
public @Nullable String build()

Build query string.

Returns:

Query string or null if query string contains no parameters at all.