Class: RequestParameter

vertx-web-api-contract-js/request_parameter~ RequestParameter

new RequestParameter()

Request parameter holder
Source:

Methods

getArray() → {Array.<RequestParameter>}

Returns null if value is not a list, otherwise it returns value
Source:
Returns:
Type
Array.<RequestParameter>

getBoolean() → {boolean}

Returns null if value is not a Boolean, otherwise it returns value
Source:
Returns:
Type
boolean

getDouble() → {number}

Returns null if value is not a Double, otherwise it returns value
Source:
Returns:
Type
number

getFloat() → {number}

Returns null if value is not a Float, otherwise it returns value
Source:
Returns:
Type
number

getInteger() → {number}

Returns null if value is not an Integer, otherwise it returns value
Source:
Returns:
Type
number

getJsonArray() → {todo}

Returns null if value is not a JsonArray, otherwise it returns value
Source:
Returns:
Type
todo

getJsonObject() → {Object}

Returns null if value is not a JsonObject, otherwise it returns value
Source:
Returns:
Type
Object

getLong() → {number}

Returns null if value is not a Long, otherwise it returns value
Source:
Returns:
Type
number

getName() → {string}

Get parameter name
Source:
Returns:
Type
string

getObjectKeys() → {Array.<string>}

If value is a map of fields, it returns keys of map, otherwise it returns null
Source:
Returns:
Type
Array.<string>

getObjectValue(key) → {RequestParameter}

If value is a map of fields, it returns value of field with key provided, otherwise it returns null
Parameters:
Name Type Description
key string
Source:
Returns:
Type
RequestParameter

getString() → {string}

Returns null if value is not a String, otherwise it returns value
Source:
Returns:
Type
string

isArray() → {boolean}

Returns true if value of RequestParameter is an array
Source:
Returns:
Type
boolean

isBoolean() → {boolean}

Returns true if value of RequestParameter is a Boolean instance
Source:
Returns:
Type
boolean

isDouble() → {boolean}

Returns true if value of RequestParameter is a Double instance
Source:
Returns:
Type
boolean

isEmpty() → {boolean}

Alias of RequestParameter#isNull
Source:
Returns:
Type
boolean

isFloat() → {boolean}

Returns true if value of RequestParameter is a Float instance
Source:
Returns:
Type
boolean

isInteger() → {boolean}

Returns true if value of RequestParameter is an Integer instance
Source:
Returns:
Type
boolean

isJsonArray() → {boolean}

Returns true if value of RequestParameter is a JsonArray instance
Source:
Returns:
Type
boolean

isJsonObject() → {boolean}

Returns true if value of RequestParameter is a JsonObject instance
Source:
Returns:
Type
boolean

isLong() → {boolean}

Returns true if value of RequestParameter is a Long instance
Source:
Returns:
Type
boolean

isNull() → {boolean}

Returns true if value is null
Source:
Returns:
Type
boolean

isObject() → {boolean}

Returns true if value of RequestParameter is a map of fields
Source:
Returns:
Type
boolean

isString() → {boolean}

Returns true if value of RequestParameter is a String instance
Source:
Returns:
Type
boolean

merge(otherParameter) → {RequestParameter}

Merge this request parameter with another one. Note: the parameter passed by argument has the priority
Parameters:
Name Type Description
otherParameter RequestParameter
Source:
Returns:
Type
RequestParameter

setName(name)

Set parameter name
Parameters:
Name Type Description
name string
Source:

setValue(value)

Set value
Parameters:
Name Type Description
value Object
Source: