Class: VertxWeb::LanguageHeader

Inherits:
Object
  • Object
show all
Includes:
ParsedHeaderValue
Defined in:
/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb

Overview

A parsed language header. Delivers a more direct access to the individual elements of the header it represents

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


21
22
23
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 21

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

+ (Object) DEFAULT_WEIGHT

If no "q" parameter is present, the default weight is 1.


198
199
200
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 198

def self.DEFAULT_WEIGHT
  Java::IoVertxExtWeb::LanguageHeader.DEFAULT_WEIGHT
end

+ (Object) j_api_type



30
31
32
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 30

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



33
34
35
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 33

def self.j_class
  Java::IoVertxExtWeb::LanguageHeader.java_class
end

+ (Object) unwrap(obj)



27
28
29
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 27

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

+ (Object) wrap(obj)



24
25
26
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 24

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

Instance Method Details

- (true, false) isMatchedBy(matchTry)

Test if this header is matched by matchTry header

Parameters:

Returns:

  • (true, false)
    true if this header represents a subset of matchTry, otherwise, false


187
188
189
190
191
192
193
194
195
196
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 187

def matched_by?(*args)
  if args[0].class.method_defined?(:j_del) && !block_given?
    return @j_del.java_method(:isMatchedBy, [Java::IoVertxExtWeb::ParsedHeaderValue.java_class]).call(args[0].j_del)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling matched_by?(#{args[0]})"
  end
end

- (String) parameter(key)

The value of the parameter specified by this key. Each is one of 3 things:
  1. null <- That key was not specified
  2. ParsedHeaderValue.EMPTY (tested using ==) <- The value was not specified
  3. [Other] <- The value of the parameter
Note: The q parameter is never present.

Parameters:

  • key (String)

Returns:

  • (String)


103
104
105
106
107
108
109
110
111
112
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 103

def parameter(*args)
  if args[0].class == String && !block_given?
    return @j_del.java_method(:parameter, [Java::java.lang.String.java_class]).call(args[0])
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling parameter(#{args[0]})"
  end
end

- (Hash{String => String}) parameters

The parameters specified in this header value. Note: The q parameter is never present.

Returns:

  • (Hash{String => String})
    Unmodifiable Map of parameters of this header value


147
148
149
150
151
152
153
154
155
156
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 147

def parameters
  if !block_given?
    return Java::IoVertxLangRuby::Helper.adaptingMap(@j_del.java_method(:parameters, []).call(), Proc.new { |val| val }, Proc.new { |val| ::Vertx::Util::Utils.to_string(val) })
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling parameters()"
  end
end

- (true, false) isPermitted

Is this an allowed operation as specified by the corresponding header?

Returns:

  • (true, false)


83
84
85
86
87
88
89
90
91
92
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 83

def permitted?
  if !block_given?
    return @j_del.java_method(:isPermitted, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling permitted?()"
  end
end

- (String) rawValue

Contains the raw value that was received from the user agent

Returns:

  • (String)


52
53
54
55
56
57
58
59
60
61
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 52

def raw_value
  if !block_given?
    return @j_del.java_method(:rawValue, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling raw_value()"
  end
end

- (String) subtag - (String) subtag(level)

A subtag of this language header.
+ info: rfc7231#section-3.1.3.1

Overloads:

  • - (String) subtag(level)

    Parameters:

    • level (Fixnum)

Returns:

  • (String)
    The language subtag at specified position


68
69
70
71
72
73
74
75
76
77
78
79
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 68

def subtag(*args)
  if !block_given? && args[0] == nil
    return @j_del.java_method(:subtag, []).call()
  elsif args[0].class == Fixnum && !block_given?
    return @j_del.java_method(:subtag, [Java::int.java_class]).call(args[0])
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling subtag(#{args[0]})"
  end
end

- (Fixnum) subtagCount

Returns the number of subtags this value has

Returns:

  • (Fixnum)
    the number of subtags this value has


173
174
175
176
177
178
179
180
181
182
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 173

def subtag_count
  if !block_given?
    return @j_del.java_method(:subtagCount, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling subtag_count()"
  end
end

- (String) tag

The tag of the language as specified by rfc7231#section-3.1.3.1.
Equivalent to

Returns:

  • (String)
    The language tag


133
134
135
136
137
138
139
140
141
142
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 133

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

- (String) value

Holds the unparsed value of the header.
For the most part, this is the content before the semi-colon (";")

Returns:

  • (String)


161
162
163
164
165
166
167
168
169
170
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 161

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

- (Float) weight

Holds the weight specified in the "q" parameter of the header.
If the parameter is not specified, 1.0 is assumed according to rfc7231

Returns:

  • (Float)


118
119
120
121
122
123
124
125
126
127
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 118

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

- (Fixnum) weightedOrder

An integer that represents the absolute order position of this header

Returns:

  • (Fixnum)


39
40
41
42
43
44
45
46
47
48
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-web/language_header.rb', line 39

def weighted_order
  if !block_given?
    return @j_del.java_method(:weightedOrder, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling weighted_order()"
  end
end