collection4js

集合工具集，HashMap/ArrayList等

描述（Description）

本项目提供了一个集合类库，在NodeJs和浏览器上都能运行的类库（This project provides a collection library that runs on NodeJs and browsers.）

• HashMap 允许string|number类型的键，任何类型的值。(Allow string | number type keys, any type of value.)
• ArrayList 允许任何类型的值。(Allow any type of value.)

链式调用（Method chaining）

所有不返回内容的方法都将返回实例以支持链式调用。（All methods that do not return content will return instances to support chain calls）

HashMap

构造函数重载（constructor overloads）

• new HashMap() 创建一个空的hashmap
• new HashMap(map:HashMap) 使用键值对创建一个hashmap

函数（methods）

• get(key: K): V 返回键存储的值（Returns the value stored by the key）
• put(key: K, value: V) this; 插入键值对（Insert key-value pairs）
• keys(): Array<K> 返回所有键的数组(Returns an array of all keys)
• containsKey(key: K):boolean 是否包含键（Does it contain keys）
• values(): Array<V> //返回所有值的数组 (Returns an array of all values)
• forEach(callbackfn: (key: K, value: V) => boolean | any, context?: any): void 遍历这些键值对并为每对调用函数(Iterate over these key-value pairs and call functions for each pair) @param callbackfn 初次循环的回调，函数内 return false 终止整个循环，return 任意非 false 的值终止单次循环 @param context 回调函数内上下文
• remove(key: K): void //删除键值根据键 (Delete key-value pairs by key)
• clear(): void 删除所有键值对(Delete all key-value pairs)
• size(): number 键值对集的大小(The size of key-value pairs)
• clone(): Map<K, V> 克隆成为一个新的键值对集合(The clone becomes a new set of key-value pairs)
• isEmpty(): boolean 是否为空集合(Is it a set of null key-value pairs)

例子（Examples）

如果您在Node中使用，则首先需要导入该类（If you use it in Node, you first need to import this class）

import { HashMap } from 'collection4js';
var Collection4js = require('collection4js');
var hashMap = new Collection4js.HashMap();
//更多map待后续更新(More maps to be updated later)

简单用例(Simple use cases)

map.put("key1", "value");

键值对集合大小（Map size）

map.put("key1", "value");
map.put("key2", "value");
map.size; // -> 2

删除键值对（Delete key-value pairs）

map.put("key1", "value");
map.remove("key1");
map.get("key1"); // --> null

相同键覆盖(Same key coverage)

map.put("key1", "one");
map.put("key1", "two");
map.get("key1"); // --> "two"

迭代（Iterating）

map.put(1, "1");
map.put(2, "2");
map.put(3, "3");

map.forEach(function(key, value) {
    console.log(key + " : " + value);
});

链式调用（Method chaining）

map
  .put(1, "1")
  .put(2, "2")
  .put(3, "3")
  .forEach(function(value, key) {
      console.log(key + " : " + value);
  });

LinkedHashMap

等待后续更新

ArrayList

构造函数重载（constructor overloads）

• new ArrayList() 创建一个空的 arraylist
• new ArrayList(list?: List<T> | Array<T>) 使用数组或已有集合创建一个arraylist

函数（methods）

• size(): number 集合大小（Collection size）
• add(value: T): this 插入元素（Insert elements）
• addAll(values: T[] | List<T>): this 插入多个元素（Insert multiple elements）
• get(index: number): T 获取元素（Get elements）
• removeIndex(index: number): T 移除指定下标的元素(Remove the specified subscript element)
• removeObject(obj: T): T 移除指定元素(Remove the specified element)
• isEmpty(): boolean 是否为空(Is it empty)
• isEmpty(): boolean 遍历这些元素并为每对调用函数(Iterate over these element and call functions for each) @param callbackfn 初次循环的回调，函数内 return false 终止整个循环，return 任意非 false 的值终止单次循环 context 回调函数内上下文
• forEach(callbackfn: (value: T) => boolean | any, context?: any): void 遍历这些元素并为每对调用函数(Iterate over these element and call functions for each)
• clear(): void 清空(clear)
• contains(obj: T): boolean 是否包含元素(Does it contain elements)
• indexOf(obj: T): number 获取元素下标(Get element Subscripts)
• toArray(): Array<T> 转换为数组（Converting to array）
• sort(sortBy: (a: T, b: T) => number): this 元素排序（elements sort） @param sortBy 若 a 小于 b，在排序后的集合中 a 应该出现在 b 之前，则返回一个小于 0 的值。 若 a 等于 b，则返回 0。若 a 大于 b，则返回一个大于 0 的值。 （If A is less than b, A should appear before B in the sorted set, then a value less than 0 is returned. If a equals b, return 0. If A is greater than b, a value greater than 0 is returned.）

例子（Examples）

如果您在Node中使用，则首先需要导入该类（If you use it in Node, you first need to import this class）

import { ArrayList } from 'collection4js';
var Collection4js = require('collection4js');
var arrayList = new Collection4js.ArrayList();
var arrayList2 = new ArrayList();
//更多map待后续更新(More maps to be updated later)

####简单用例(Simple use cases)

list.add('value1')
console.log(list.get(0))

####集合大小（List size）

list.add("value1");
list.add("value2");
console.log(list.size())

###删除元素（Delete Element）

list.add("value1");
list.removeIndex(0);
//list.removeIndex(0) or list.removeObject('value1')

console.log(list.get(0))

####排序（sort elements）

list.add({order: 3, value: 'value3'})
    .add({order: 2, value: 'value2'})
    .add({order: 1, value: 'value1'})
    .sort(function(a,b) {
        return a.order - b.order
    }).forEach(function (value) {
        console.log(value.value)
    });

####迭代（Iterating）

list.add("value1");
list.add("value2");
list.add("value3");

list.forEach(function (value) {
    console.log(value);
})

####链式调用（Method chaining）

list.add("value1")
     .add("value2")
     .add("value3")
     .forEach(function (value) {
        console.log(value);
     });

To-Do