/*
* Copyright 2014 Red Hat, Inc.
*
* Red Hat licenses this file to you under the Apache License, version 2.0
* (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
/** @module vertx-web-js/language_header */
var utils = require('vertx-js/util/utils');
var ParsedHeaderValue = require('vertx-web-js/parsed_header_value');
var Locale = require('vertx-web-js/locale');
var io = Packages.io;
var JsonObject = io.vertx.core.json.JsonObject;
var JLanguageHeader = Java.type('io.vertx.ext.web.LanguageHeader');
/**
A parsed language header.
Delivers a more direct access to the individual elements of the header it represents
@class
*/
var LanguageHeader = function(j_val) {
var j_languageHeader = j_val;
var that = this;
ParsedHeaderValue.call(this, j_val);
Locale.call(this, j_val);
/**
Contains the raw value that was received from the user agent
@public
@return {string}
*/
this.rawValue = function() {
var __args = arguments;
if (__args.length === 0) {
return j_languageHeader["rawValue()"]();
} else throw new TypeError('function invoked with invalid arguments');
};
/**
Holds the unparsed value of the header.<br>
For the most part, this is the content before the semi-colon (";")
@public
@return {string}
*/
this.value = function() {
var __args = arguments;
if (__args.length === 0) {
return j_languageHeader["value()"]();
} else throw new TypeError('function invoked with invalid arguments');
};
/**
Holds the weight specified in the "q" parameter of the header.<br>
If the parameter is not specified, 1.0 is assumed according to
<a href="https://tools.ietf.org/html/rfc7231#section-5.3.1">rfc7231</a>
@public
@return {number}
*/
this.weight = function() {
var __args = arguments;
if (__args.length === 0) {
return j_languageHeader["weight()"]();
} else throw new TypeError('function invoked with invalid arguments');
};
/**
The value of the parameter specified by this key. Each is one of 3 things:
<ol>
<li>null <- That key was not specified</li>
<li>ParsedHeaderValue.EMPTY (tested using ==) <- The value was not specified</li>
<li>[Other] <- The value of the parameter</li>
</ol>
<b>Note:</b> The <code>q</code> parameter is never present.
@public
@param key {string}
@return {string}
*/
this.parameter = function(key) {
var __args = arguments;
if (__args.length === 1 && typeof __args[0] === 'string') {
return j_languageHeader["parameter(java.lang.String)"](key);
} else throw new TypeError('function invoked with invalid arguments');
};
/**
The parameters specified in this header value.
<b>Note:</b> The <code>q</code> parameter is never present.
@public
@return {Array.<string>} Unmodifiable Map of parameters of this header value
*/
this.parameters = function() {
var __args = arguments;
if (__args.length === 0) {
return utils.convReturnMap(j_languageHeader["parameters()"]());
} else throw new TypeError('function invoked with invalid arguments');
};
/**
Is this an allowed operation as specified by the corresponding header?
@public
@return {boolean}
*/
this.isPermitted = function() {
var __args = arguments;
if (__args.length === 0) {
return j_languageHeader["isPermitted()"]();
} else throw new TypeError('function invoked with invalid arguments');
};
/**
Test if this header is matched by matchTry header
@public
@param matchTry {ParsedHeaderValue} The header to be matched from
@return {boolean} true if this header represents a subset of matchTry, otherwise, false
*/
this.isMatchedBy = function(matchTry) {
var __args = arguments;
if (__args.length === 1 && typeof __args[0] === 'object' && __args[0]._jdel) {
return j_languageHeader["isMatchedBy(io.vertx.ext.web.ParsedHeaderValue)"](matchTry._jdel);
} else throw new TypeError('function invoked with invalid arguments');
};
/**
An integer that represents the absolute order position of this header
@public
@return {number}
*/
this.weightedOrder = function() {
var __args = arguments;
if (__args.length === 0) {
return j_languageHeader["weightedOrder()"]();
} else throw new TypeError('function invoked with invalid arguments');
};
/**
Returns the language as reported by the HTTP client.
@public
@return {string} language
*/
this.language = function() {
var __args = arguments;
if (__args.length === 0) {
return j_languageHeader["language()"]();
} else throw new TypeError('function invoked with invalid arguments');
};
/**
Returns the country as reported by the HTTP client.
@public
@return {string} variant
*/
this.country = function() {
var __args = arguments;
if (__args.length === 0) {
return j_languageHeader["country()"]();
} else throw new TypeError('function invoked with invalid arguments');
};
/**
Returns the variant as reported by the HTTP client.
@public
@return {string} variant
*/
this.variant = function() {
var __args = arguments;
if (__args.length === 0) {
return j_languageHeader["variant()"]();
} else throw new TypeError('function invoked with invalid arguments');
};
/**
The tag of the language as specified by
<a href="https://tools.ietf.org/html/rfc7231#section-3.1.3.1">rfc7231#section-3.1.3.1</a>.<br>
Equivalent to
@public
@return {string} The language tag
*/
this.tag = function() {
var __args = arguments;
if (__args.length === 0) {
return j_languageHeader["tag()"]();
} else throw new TypeError('function invoked with invalid arguments');
};
/**
A subtag of this language header.<br>
+ info: <a href="https://tools.ietf.org/html/rfc7231#section-3.1.3.1">rfc7231#section-3.1.3.1</a>
@public
@param level {number}
@return {string} The language subtag at specified position
*/
this.subtag = function() {
var __args = arguments;
if (__args.length === 0) {
return j_languageHeader["subtag()"]();
} else if (__args.length === 1 && typeof __args[0] ==='number') {
return j_languageHeader["subtag(int)"](__args[0]);
} else throw new TypeError('function invoked with invalid arguments');
};
/**
@public
@return {number} the number of subtags this value has
*/
this.subtagCount = function() {
var __args = arguments;
if (__args.length === 0) {
return j_languageHeader["subtagCount()"]();
} else throw new TypeError('function invoked with invalid arguments');
};
// A reference to the underlying Java delegate
// NOTE! This is an internal API and must not be used in user code.
// If you rely on this property your code is likely to break if we change it / remove it without warning.
this._jdel = j_languageHeader;
};
LanguageHeader._jclass = utils.getJavaClass("io.vertx.ext.web.LanguageHeader");
LanguageHeader._jtype = {
accept: function(obj) {
return LanguageHeader._jclass.isInstance(obj._jdel);
},
wrap: function(jdel) {
var obj = Object.create(LanguageHeader.prototype, {});
LanguageHeader.apply(obj, arguments);
return obj;
},
unwrap: function(obj) {
return obj._jdel;
}
};
LanguageHeader._create = function(jdel) {
var obj = Object.create(LanguageHeader.prototype, {});
LanguageHeader.apply(obj, arguments);
return obj;
}
module.exports = LanguageHeader;