io.muserver

Interface RequestParameters

public interface RequestParameters

Provides access to QueryString or Form values.

Method Summary

Modifier and Type	Method and Description
Map<String,List<String>>	all() Gets all the parameters as a map
boolean	contains(String name) Returns true if the given parameter is specified with any value
String	get(String name) Gets the value with the given name, or null if there is no parameter with that name.
String	get(String name, String defaultValue) Gets the value with the given name, or the default value if there is no parameter with that name.
List<String>	getAll(String name) Gets all the parameters with the given name, or an empty list if none are found.
boolean	getBoolean(String name) Gets a parameter as a boolean, where values such as true, on and yes as considered true, and other values (or no parameter with the name) is considered false.
double	getDouble(String name, double defaultValue) Gets the parameter as a double, or returns the default value if it was not specified or was in an invalid format.
float	getFloat(String name, float defaultValue) Gets the parameter as a float, or returns the default value if it was not specified or was in an invalid format.
int	getInt(String name, int defaultValue) Gets the parameter as an integer, or returns the default value if it was not specified or was in an invalid format.
long	getLong(String name, long defaultValue) Gets the parameter as a long, or returns the default value if it was not specified or was in an invalid format.

Method Detail

all

Map<String,List<String>> all()

Gets all the parameters as a map

Returns:

A map of parameter names to value list

get

String get(String name)

Gets the value with the given name, or null if there is no parameter with that name.

If there are multiple parameters with the same name, the first one is returned.

Parameters:

name - The name of the parameter to get

Returns:

The value, or null

get

String get(String name,
           String defaultValue)

Gets the value with the given name, or the default value if there is no parameter with that name.

If there are multiple parameters with the same name, the first one is returned.

Parameters:

name - The name of the parameter to get

defaultValue - The default value to use if there is no given value

Returns:

The value of the parameter, or the default value

getInt

int getInt(String name,
           int defaultValue)

Gets the parameter as an integer, or returns the default value if it was not specified or was in an invalid format.

Parameters:

name - The name of the parameter.

defaultValue - The value to use if none was specified, or an invalid format was used.

Returns:

Returns the parameter value as an integer.

getLong

long getLong(String name,
             long defaultValue)

Gets the parameter as a long, or returns the default value if it was not specified or was in an invalid format.

Parameters:

name - The name of the parameter.

defaultValue - The value to use if none was specified, or an invalid format was used.

Returns:

Returns the parameter value as a long.

getFloat

float getFloat(String name,
               float defaultValue)

Gets the parameter as a float, or returns the default value if it was not specified or was in an invalid format.

Parameters:

name - The name of the parameter.

defaultValue - The value to use if none was specified, or an invalid format was used.

Returns:

Returns the parameter value as a float.

getDouble

double getDouble(String name,
                 double defaultValue)

Gets the parameter as a double, or returns the default value if it was not specified or was in an invalid format.

Parameters:

name - The name of the parameter.

defaultValue - The value to use if none was specified, or an invalid format was used.

Returns:

Returns the parameter value as a double.

getBoolean

boolean getBoolean(String name)

Gets a parameter as a boolean, where values such as true, on and yes as considered true, and other values (or no parameter with the name) is considered false.

This can be used to access checkbox values as booleans.

Parameters:

name - The name of the parameter.

Returns:

Returns true if the value was truthy, or false if it was falsy or not specified.

getAll

List<String> getAll(String name)

Gets all the parameters with the given name, or an empty list if none are found.

Parameters:

name - The parameter name to get

Returns:

All values of the parameter with the given name

contains

boolean contains(String name)

Returns true if the given parameter is specified with any value

Parameters:

name - The name of the value

Returns:

True if it's specified; otherwise false.