bugcore
Version:
bugcore is a JavaScript library that provides a foundational architecture for object oriented JS
124 lines (94 loc) • 3.38 kB
JavaScript
/*
* Copyright (c) 2016 airbug Inc. http://airbug.com
*
* bugcore may be freely distributed under the MIT license.
*/
//-------------------------------------------------------------------------------
// Annotations
//-------------------------------------------------------------------------------
//@Export('ICollection')
//@Require('IArrayable')
//@Require('Interface')
//-------------------------------------------------------------------------------
// Context
//-------------------------------------------------------------------------------
require('bugpack').context("*", function(bugpack) {
//-------------------------------------------------------------------------------
// BugPack
//-------------------------------------------------------------------------------
var IArrayable = bugpack.require('IArrayable');
var Interface = bugpack.require('Interface');
//-------------------------------------------------------------------------------
// Declare Interface
//-------------------------------------------------------------------------------
/**
* @interface
* @extends {IArrayable<I>}
* @template I
*/
var ICollection = Interface.extend(IArrayable, {
_name: "ICollection",
//-------------------------------------------------------------------------------
// Interface Methods
//-------------------------------------------------------------------------------
/**
* @param {I} item
* @return {boolean}
*/
add: function(item) {},
/**
* @param {(IIterable<I> | IArrayable<I> | Array<I>)} items
*/
addAll: function(items) {},
/**
*
*/
clear: function() {},
/**
* @param {*} value
* @return {boolean}
*/
contains: function(value) {},
/**
* Multiple elements are ignored in this function.
* e.g. Collection[0,1] containsAll Collection[0,1,1,1] is true
* If you want to check for exact equality, use the equals function.
* Empty collections are always contained by another collection
* e.g. Collection[0,1] containsAll Collection[] is true
* @param {(IIterable<I> | IArrayable<I> | Array<*>)} values
* @return {boolean}
*/
containsAll: function(values) {},
/**
* @param {(IIterable<I> | IArrayable<I> | Array<*>)} values
* @return {boolean}
*/
containsEqual: function(values) {},
/**
* @param {*} value
* @return {number}
*/
countValue: function(value) {},
/**
* @return {number}
*/
getCount: function() {},
/**
* @return {boolean}
*/
isEmpty: function() {},
/**
* @param {*} value
* @return {boolean}
*/
remove: function(value) {},
/**
* @param {(IIterable<I> | IArrayable<I> | Array<*>)} values
*/
removeAll: function(values) {}
});
//-------------------------------------------------------------------------------
// Exports
//-------------------------------------------------------------------------------
bugpack.export('ICollection', ICollection);
});