vertx / io.vertx.ext.web.api / RequestParameter

RequestParameter

interface RequestParameter

Request parameter holder

Author
Francesco Guardiani @slinkydeveloper

Functions

create

open static fun create(name: String, value: Any): RequestParameter
open static fun create(value: Any): RequestParameter

getArray

abstract fun getArray(): MutableList<RequestParameter>

Returns null if value is not a list, otherwise it returns value

getBoolean

abstract fun getBoolean(): Boolean

Returns null if value is not a Boolean, otherwise it returns value

getDouble

abstract fun getDouble(): Double

Returns null if value is not a Double, otherwise it returns value

getFloat

abstract fun getFloat(): Float

Returns null if value is not a Float, otherwise it returns value

getInteger

abstract fun getInteger(): Int

Returns null if value is not an Integer, otherwise it returns value

getJsonArray

abstract fun getJsonArray(): JsonArray

Returns null if value is not a JsonArray, otherwise it returns value

getJsonObject

abstract fun getJsonObject(): JsonObject

Returns null if value is not a JsonObject, otherwise it returns value

getLong

abstract fun getLong(): Long

Returns null if value is not a Long, otherwise it returns value

getName

abstract fun getName(): String

Get parameter name

getObjectKeys

abstract fun getObjectKeys(): MutableList<String>

If value is a map of fields, it returns keys of map, otherwise it returns null

getObjectValue

abstract fun getObjectValue(key: String): RequestParameter

If value is a map of fields, it returns value of field with key provided, otherwise it returns null

getString

abstract fun getString(): String

Returns null if value is not a String, otherwise it returns value

isArray

abstract fun isArray(): Boolean

Returns true if value of RequestParameter is an array

isBoolean

abstract fun isBoolean(): Boolean

Returns true if value of RequestParameter is a Boolean instance

isDouble

abstract fun isDouble(): Boolean

Returns true if value of RequestParameter is a Double instance

isEmpty

abstract fun isEmpty(): Boolean

Alias of RequestParameter#isNull()

isFloat

abstract fun isFloat(): Boolean

Returns true if value of RequestParameter is a Float instance

isInteger

abstract fun isInteger(): Boolean

Returns true if value of RequestParameter is an Integer instance

isJsonArray

abstract fun isJsonArray(): Boolean

Returns true if value of RequestParameter is a JsonArray instance

isJsonObject

abstract fun isJsonObject(): Boolean

Returns true if value of RequestParameter is a JsonObject instance

isLong

abstract fun isLong(): Boolean

Returns true if value of RequestParameter is a Long instance

isNull

abstract fun isNull(): Boolean

Returns true if value is null

isObject

abstract fun isObject(): Boolean

Returns true if value of RequestParameter is a map of fields

isString

abstract fun isString(): Boolean

Returns true if value of RequestParameter is a String instance

merge

abstract fun merge(otherParameter: RequestParameter): RequestParameter

Merge this request parameter with another one. Note: the parameter passed by argument has the priority

setName

abstract fun setName(name: String): Unit

Set parameter name

setValue

abstract fun setValue(value: Any): Unit

Set value