blob: 4333984ffe8d148e18b661e9dd821b05940e08af [file] [log] [blame]
/*
* Copyright (C) 2016 Devin Rousso <webkit@devinrousso.com>. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
WI.Collection = class Collection extends WI.Object
{
constructor(items = [])
{
super();
this._items = new Set;
for (let item of items)
this.add(item);
}
// Public
get items() { return this._items; }
get displayName()
{
throw WI.NotImplementedError.subclassMustOverride();
}
objectIsRequiredType(object)
{
throw WI.NotImplementedError.subclassMustOverride();
}
add(item)
{
let isValidType = this.objectIsRequiredType(item);
console.assert(isValidType);
if (!isValidType)
return;
console.assert(!this._items.has(item));
this._items.add(item);
this.itemAdded(item);
this.dispatchEventToListeners(WI.Collection.Event.ItemAdded, {item});
}
remove(item)
{
let wasRemoved = this._items.delete(item);
console.assert(wasRemoved);
this.itemRemoved(item);
this.dispatchEventToListeners(WI.Collection.Event.ItemRemoved, {item});
}
clear()
{
let items = new Set(this._items);
this._items.clear();
this.itemsCleared(items);
for (let item of items)
this.dispatchEventToListeners(WI.Collection.Event.ItemRemoved, {item});
}
toArray()
{
return Array.from(this._items);
}
toJSON()
{
return this.toArray();
}
// Protected
itemAdded(item)
{
// Implemented by subclasses.
}
itemRemoved(item)
{
// Implemented by subclasses.
}
itemsCleared(items)
{
// Implemented by subclasses.
}
};
WI.Collection.Event = {
ItemAdded: "collection-item-added",
ItemRemoved: "collection-item-removed",
};