collection.js 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. // Copyright 2011 The Closure Library Authors. All Rights Reserved.
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS-IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. /**
  15. * @fileoverview Defines the collection interface.
  16. *
  17. * @author nnaze@google.com (Nathan Naze)
  18. */
  19. goog.provide('goog.structs.Collection');
  20. /**
  21. * An interface for a collection of values.
  22. * @interface
  23. * @template T
  24. */
  25. goog.structs.Collection = function() {};
  26. /**
  27. * @param {T} value Value to add to the collection.
  28. */
  29. goog.structs.Collection.prototype.add;
  30. /**
  31. * @param {T} value Value to remove from the collection.
  32. */
  33. goog.structs.Collection.prototype.remove;
  34. /**
  35. * @param {T} value Value to find in the collection.
  36. * @return {boolean} Whether the collection contains the specified value.
  37. */
  38. goog.structs.Collection.prototype.contains;
  39. /**
  40. * @return {number} The number of values stored in the collection.
  41. */
  42. goog.structs.Collection.prototype.getCount;