We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.router.
Class QueryParameters
- java.lang.Object
-
- com.vaadin.flow.router.QueryParameters
-
All Implemented Interfaces:
public class QueryParameters extends Object implements SerializableHolds query parameters information.
Since:
1.0.
Author:
Vaadin Ltd
See Also:
-
-
Constructor Summary
Constructors Constructor and Description QueryParameters(Map<String,List<String>> parameters)Creates query parameters from parameter map.
-
Method Summary
All Methods Modifier and Type Method and Description static QueryParametersempty()Creates an empty query parameters information.
static QueryParametersfromString(String queryString)Creates parameters from a query string.
static QueryParametersfull(Map<String,String[]> parameters)Creates parameters from full representation, where each parameter name may correspond to multiple values.
Map<String,List<String>>getParameters()Returns query parameters information with support for multiple values corresponding to single parameter name.
StringgetQueryString()Returns a UTF-8 encoded query string containing all parameter names and values suitable for appending to a URL after the
?character.static QueryParameterssimple(Map<String,String> parameters)Creates parameters from simple representation, where each parameter name corresponds to a single value.
-
-
-
Method Detail
-
empty
public static QueryParameters empty()Creates an empty query parameters information.
Returns:
query parameters information
-
full
public static QueryParameters full(Map<String,String[]> parameters)Creates parameters from full representation, where each parameter name may correspond to multiple values.
Parameters:
parameters- query parameters mapReturns:
query parameters information
-
simple
public static QueryParameters simple(Map<String,String> parameters)Creates parameters from simple representation, where each parameter name corresponds to a single value.
Parameters:
parameters- query parameters mapReturns:
query parameters information
-
fromString
public static QueryParameters fromString(String queryString)Creates parameters from a query string.
Note that no length checking is done for the string. It is the responsibility of the caller (or the server) to limit the length of the query string.
Parameters:
queryString- the query stringReturns:
query parameters information
-
getParameters
public Map<String,List<String>> getParameters()Returns query parameters information with support for multiple values corresponding to single parameter name.
Example:
https://example.com/?one=1&two=2&one=3will result in the corresponding map:{"one" : [1, 3], "two": [2]}Returns:
query parameters information
-
getQueryString
public String getQueryString()Returns a UTF-8 encoded query string containing all parameter names and values suitable for appending to a URL after the
?character. Parameters may appear in different order than in the query string they were originally parsed from, and may be differently encoded (for example, if a space was encoded as+in the initial URL it will be encoded as%20in the result.Returns:
query string suitable for appending to a URL
See Also:
-
-