joynr.types.CustomParameter.js Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of libjoynr-js Show documentation
JOYnr JavaScript libjoynr-js
The newest version!
/**
 * This is the generated struct type CustomParameter: DOCS GENERATED FROM INTERFACE DESCRIPTION
 * Generation date: Mon Jul 09 14:02:45 CEST 2018
 */
(function(undefined) {
	/**
	 * @name CustomParameter
	 * @constructor
	 *
	 * @classdesc
	 * This is the generated struct type CustomParameter: DOCS GENERATED FROM INTERFACE DESCRIPTION
	 * 
Generation date: Mon Jul 09 14:02:45 CEST 2018
	 * 

a custom parameter consisting of a name and a value
	 *
	 * @param {Object} members - an object containing the individual member elements
	 * @param {String} members.name - the name of the custom parameter
	 * @param {String} members.value - the value of the custom parameter
	 * @returns {CustomParameter} a new instance of a CustomParameter
	 */
	var CustomParameter = function CustomParameter(members) {
		if (!(this instanceof CustomParameter)) {
			// in case someone calls constructor without new keyword (e.g. var c = Constructor({..}))
			return new CustomParameter(members);
		}

		/**
		 * Used for serialization.
		 * @name CustomParameter#_typeName
		 * @type String
		 * @readonly
		 */
		Object.defineProperty(this, "_typeName", {
			enumerable : true,
			value : CustomParameter._typeName
		});

		/**
		 * the name of the custom parameter
		 * @name CustomParameter#name
		 * @type String
		 */
		/**
		 * the value of the custom parameter
		 * @name CustomParameter#value
		 * @type String
		 */

		if (members !== undefined) {
			this.name = members.name;
			this.value = members.value;
		}

	};

	Object.defineProperty(CustomParameter, "_typeName", {
		value : "joynr.types.CustomParameter"
	});

	Object.defineProperty(CustomParameter, 'checkMembers', {
		value: function checkMembers(instance, check) {
			check(instance.name, "String", "members.name");
			check(instance.value, "String", "members.value");
		}
	});

	/**
	 * @name CustomParameter#MAJOR_VERSION
	 * @constant {Number}
	 * @default 0
	 * @summary The MAJOR_VERSION of the struct type CustomParameter is GENERATED FROM THE INTERFACE DESCRIPTION
	 */
	Object.defineProperty(CustomParameter, 'MAJOR_VERSION', { value: 0 });
	/**
	 * @name CustomParameter#MINOR_VERSION
	 * @constant {Number}
	 * @default 0
	 * @summary The MINOR_VERSION of the struct type CustomParameter is GENERATED FROM THE INTERFACE DESCRIPTION
	 */
	Object.defineProperty(CustomParameter, 'MINOR_VERSION', { value: 0 });

	var preparePrototype = function(joynr) {
		CustomParameter.prototype = new joynr.JoynrObject();
		CustomParameter.prototype.constructor = CustomParameter;
		joynr.util.GenerationUtil.addEqualsCompound(CustomParameter);
		joynr.util.GenerationUtil.addMemberTypeGetter(CustomParameter);
	};

	Object.defineProperty(CustomParameter, '_memberTypes', {
		value: {
			name: "String",
			value: "String"
		}
	});

	var joynr = require("joynr");
	preparePrototype(joynr);
	joynr.addType("joynr.types.CustomParameter", CustomParameter);
	module.exports = CustomParameter;
})();