Class: VertxWebApiContract::RequestParameter

Inherits:
Object
  • Object
show all
Defined in:
/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb

Overview

Request parameter holder

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


17
18
19
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 17

def @@j_api_type.accept?(obj)
  obj.class == RequestParameter
end

+ (::VertxWebApiContract::RequestParameter) create(value) + (::VertxWebApiContract::RequestParameter) create(name, value)

Overloads:

Returns:

Raises:

  • (ArgumentError)


258
259
260
261
262
263
264
265
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 258

def self.create(param_1=nil,param_2=nil)
  if ::Vertx::Util::unknown_type.accept?(param_1) && !block_given? && param_2 == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebApi::RequestParameter.java_method(:create, [Java::java.lang.Object.java_class]).call(::Vertx::Util::Utils.to_object(param_1)),::VertxWebApiContract::RequestParameter)
  elsif param_1.class == String && ::Vertx::Util::unknown_type.accept?(param_2) && !block_given?
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebApi::RequestParameter.java_method(:create, [Java::java.lang.String.java_class,Java::java.lang.Object.java_class]).call(param_1,::Vertx::Util::Utils.to_object(param_2)),::VertxWebApiContract::RequestParameter)
  end
  raise ArgumentError, "Invalid arguments when calling create(#{param_1},#{param_2})"
end

+ (Object) j_api_type



26
27
28
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 26

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



29
30
31
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 29

def self.j_class
  Java::IoVertxExtWebApi::RequestParameter.java_class
end

+ (Object) unwrap(obj)



23
24
25
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 23

def @@j_api_type.unwrap(obj)
  obj.j_del
end

+ (Object) wrap(obj)



20
21
22
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 20

def @@j_api_type.wrap(obj)
  RequestParameter.new(obj)
end

Instance Method Details

- (true, false) array?

Returns true if value of RequestParameter is an array

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


93
94
95
96
97
98
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 93

def array?
  if !block_given?
    return @j_del.java_method(:isArray, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling array?()"
end

- (true, false) boolean?

Returns true if value of RequestParameter is a Boolean instance

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


189
190
191
192
193
194
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 189

def boolean?
  if !block_given?
    return @j_del.java_method(:isBoolean, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling boolean?()"
end

- (true, false) double?

Returns true if value of RequestParameter is a Double instance

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


173
174
175
176
177
178
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 173

def double?
  if !block_given?
    return @j_del.java_method(:isDouble, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling double?()"
end

- (true, false) empty?

Alias of #is_null

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


237
238
239
240
241
242
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 237

def empty?
  if !block_given?
    return @j_del.java_method(:isEmpty, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling empty?()"
end

- (true, false) float?

Returns true if value of RequestParameter is a Float instance

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


157
158
159
160
161
162
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 157

def float?
  if !block_given?
    return @j_del.java_method(:isFloat, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling float?()"
end

- (Array<::VertxWebApiContract::RequestParameter>) get_array

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

Returns:

Raises:

  • (ArgumentError)


85
86
87
88
89
90
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 85

def get_array
  if !block_given?
    return @j_del.java_method(:getArray, []).call().to_a.map { |elt| ::Vertx::Util::Utils.safe_create(elt,::VertxWebApiContract::RequestParameter) }
  end
  raise ArgumentError, "Invalid arguments when calling get_array()"
end

- (true, false) get_boolean?

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

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


181
182
183
184
185
186
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 181

def get_boolean?
  if !block_given?
    return @j_del.java_method(:getBoolean, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling get_boolean?()"
end

- (Float) get_double

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

Returns:

  • (Float)

Raises:

  • (ArgumentError)


165
166
167
168
169
170
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 165

def get_double
  if !block_given?
    return @j_del.java_method(:getDouble, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling get_double()"
end

- (Float) get_float

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

Returns:

  • (Float)

Raises:

  • (ArgumentError)


149
150
151
152
153
154
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 149

def get_float
  if !block_given?
    return @j_del.java_method(:getFloat, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling get_float()"
end

- (Fixnum) get_integer

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

Returns:

  • (Fixnum)

Raises:

  • (ArgumentError)


117
118
119
120
121
122
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 117

def get_integer
  if !block_given?
    return @j_del.java_method(:getInteger, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling get_integer()"
end

- (Array<String,Object>) get_json_array

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

Returns:

  • (Array<String,Object>)

Raises:

  • (ArgumentError)


213
214
215
216
217
218
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 213

def get_json_array
  if !block_given?
    return @j_del.java_method(:getJsonArray, []).call() != nil ? JSON.parse(@j_del.java_method(:getJsonArray, []).call().encode) : nil
  end
  raise ArgumentError, "Invalid arguments when calling get_json_array()"
end

- (Hash{String => Object}) get_json_object

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

Returns:

  • (Hash{String => Object})

Raises:

  • (ArgumentError)


197
198
199
200
201
202
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 197

def get_json_object
  if !block_given?
    return @j_del.java_method(:getJsonObject, []).call() != nil ? JSON.parse(@j_del.java_method(:getJsonObject, []).call().encode) : nil
  end
  raise ArgumentError, "Invalid arguments when calling get_json_object()"
end

- (Fixnum) get_long

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

Returns:

  • (Fixnum)

Raises:

  • (ArgumentError)


133
134
135
136
137
138
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 133

def get_long
  if !block_given?
    return @j_del.java_method(:getLong, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling get_long()"
end

- (String) get_name

Get parameter name

Returns:

  • (String)

Raises:

  • (ArgumentError)


52
53
54
55
56
57
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 52

def get_name
  if !block_given?
    return @j_del.java_method(:getName, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling get_name()"
end

- (Array<String>) get_object_keys

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

Returns:

  • (Array<String>)

Raises:

  • (ArgumentError)


60
61
62
63
64
65
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 60

def get_object_keys
  if !block_given?
    return @j_del.java_method(:getObjectKeys, []).call().to_a.map { |elt| elt }
  end
  raise ArgumentError, "Invalid arguments when calling get_object_keys()"
end

- (::VertxWebApiContract::RequestParameter) get_object_value(key = nil)

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

Parameters:

  • key (String) (defaults to: nil)

Returns:

Raises:

  • (ArgumentError)


69
70
71
72
73
74
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 69

def get_object_value(key=nil)
  if key.class == String && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:getObjectValue, [Java::java.lang.String.java_class]).call(key),::VertxWebApiContract::RequestParameter)
  end
  raise ArgumentError, "Invalid arguments when calling get_object_value(#{key})"
end

- (String) get_string

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

Returns:

  • (String)

Raises:

  • (ArgumentError)


101
102
103
104
105
106
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 101

def get_string
  if !block_given?
    return @j_del.java_method(:getString, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling get_string()"
end

- (true, false) integer?

Returns true if value of RequestParameter is an Integer instance

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


125
126
127
128
129
130
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 125

def integer?
  if !block_given?
    return @j_del.java_method(:isInteger, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling integer?()"
end

- (true, false) json_array?

Returns true if value of RequestParameter is a JsonArray instance

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


221
222
223
224
225
226
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 221

def json_array?
  if !block_given?
    return @j_del.java_method(:isJsonArray, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling json_array?()"
end

- (true, false) json_object?

Returns true if value of RequestParameter is a JsonObject instance

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


205
206
207
208
209
210
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 205

def json_object?
  if !block_given?
    return @j_del.java_method(:isJsonObject, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling json_object?()"
end

- (true, false) long?

Returns true if value of RequestParameter is a Long instance

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


141
142
143
144
145
146
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 141

def long?
  if !block_given?
    return @j_del.java_method(:isLong, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling long?()"
end

- (::VertxWebApiContract::RequestParameter) merge(otherParameter = nil)

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

Parameters:

Returns:

Raises:

  • (ArgumentError)


246
247
248
249
250
251
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 246

def merge(otherParameter=nil)
  if otherParameter.class.method_defined?(:j_del) && !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:merge, [Java::IoVertxExtWebApi::RequestParameter.java_class]).call(otherParameter.j_del),::VertxWebApiContract::RequestParameter)
  end
  raise ArgumentError, "Invalid arguments when calling merge(#{otherParameter})"
end

- (true, false) null?

Returns true if value is null

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


229
230
231
232
233
234
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 229

def null?
  if !block_given?
    return @j_del.java_method(:isNull, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling null?()"
end

- (true, false) object?

Returns true if value of RequestParameter is a map of fields

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


77
78
79
80
81
82
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 77

def object?
  if !block_given?
    return @j_del.java_method(:isObject, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling object?()"
end

- (void) set_name(name = nil)

This method returns an undefined value.

Set parameter name

Parameters:

  • name (String) (defaults to: nil)

Raises:

  • (ArgumentError)


35
36
37
38
39
40
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 35

def set_name(name=nil)
  if name.class == String && !block_given?
    return @j_del.java_method(:setName, [Java::java.lang.String.java_class]).call(name)
  end
  raise ArgumentError, "Invalid arguments when calling set_name(#{name})"
end

- (void) set_value(value = nil)

This method returns an undefined value.

Set value

Parameters:

  • value (Object) (defaults to: nil)

Raises:

  • (ArgumentError)


44
45
46
47
48
49
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 44

def set_value(value=nil)
  if ::Vertx::Util::unknown_type.accept?(value) && !block_given?
    return @j_del.java_method(:setValue, [Java::java.lang.Object.java_class]).call(::Vertx::Util::Utils.to_object(value))
  end
  raise ArgumentError, "Invalid arguments when calling set_value(#{value})"
end

- (true, false) string?

Returns true if value of RequestParameter is a String instance

Returns:

  • (true, false)

Raises:

  • (ArgumentError)


109
110
111
112
113
114
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web-api-contract/request_parameter.rb', line 109

def string?
  if !block_given?
    return @j_del.java_method(:isString, []).call()
  end
  raise ArgumentError, "Invalid arguments when calling string?()"
end