Package dev.relism.flash.models

Class RequestHelper

java.lang.Object

dev.relism.flash.models.RequestHelper

public final class RequestHelper
extends Object

Typed accessors for request parameters. All methods throw HttpException (400) on missing or malformed input, so handlers do not need to write per-field validation boilerplate.

 int  page = RequestHelper.queryInt(req, "page", 1, 100);
 long id   = RequestHelper.paramLong(req, "id");
 String q  = RequestHelper.queryRequired(req, "q");
 

Method Summary

Modifier and Type	Method	Description
static int	paramInt(Request req, String name)	Returns the path parameter as an int.
static long	paramLong(Request req, String name)	Returns the path parameter as a long.
static String	paramRequired(Request req, String name)	Returns the path parameter as a String.
static int	queryInt(Request req, String name, int defaultValue, int max)	Returns the query param as an int, or defaultValue if absent.
static long	queryLong(Request req, String name, long defaultValue)	Returns the query param as a long, or defaultValue if absent.
static String	queryOptional(Request req, String name)	Returns the query param, or null if absent.
static String	queryRequired(Request req, String name)	Returns the query param value.

Methods inherited from class java.lang.Object

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

Method Details

queryInt

public static int queryInt(Request req,
 String name,
 int defaultValue,
 int max)

Returns the query param as an int, or defaultValue if absent. Caps the result at max. Throws 400 on non-integer input.

queryRequired

public static String queryRequired(Request req,
 String name)

Returns the query param value. Throws 400 if absent or blank.

queryOptional

public static String queryOptional(Request req,
 String name)

Returns the query param, or null if absent.

queryLong

public static long queryLong(Request req,
 String name,
 long defaultValue)

Returns the query param as a long, or defaultValue if absent. Throws 400 on non-long input.

paramLong

public static long paramLong(Request req,
 String name)

Returns the path parameter as a long. Throws 400 if absent or non-long.

paramInt

public static int paramInt(Request req,
 String name)

Returns the path parameter as an int. Throws 400 if absent or non-int.

paramRequired

public static String paramRequired(Request req,
 String name)

Returns the path parameter as a String. Throws 400 if absent.