Change OCPP classes methods scope to protected

[e-mobility-charging-stations-simulator.git] / src / utils / CircularArray.ts

diff --git a/src/utils/CircularArray.ts b/src/utils/CircularArray.ts
index 319b6924e4494b6ca83c55ee5d4cc576a27f5d67..93dacdb0ee8d421f592ff6b05e31ef1b23b9acc4 100644 (file)
--- a/src/utils/CircularArray.ts
+++ b/src/utils/CircularArray.ts
@@ -1,36 +1,85 @@
+export const DEFAULT_CIRCULAR_ARRAY_SIZE = 2000;
 
-export default class CircularArray<T> extends Array<T> {
+/** Array with a maximum length shifting items when full. */
+export class CircularArray<T> extends Array<T> {
   public size: number;
-  private readonly MAXIMUM_CIRCULAR_ARRAY_SIZE = 2000;
 
-  constructor(size?: number) {
+  constructor(size: number = DEFAULT_CIRCULAR_ARRAY_SIZE, ...items: T[]) {
     super();
-    this.size = size && size <= this.MAXIMUM_CIRCULAR_ARRAY_SIZE ? size : this.MAXIMUM_CIRCULAR_ARRAY_SIZE;
+    this.checkSize(size);
+    this.size = size;
+    if (arguments.length > 1) {
+      this.push(...items);
+    }
+  }
+
+  public push(...items: T[]): number {
+    const length = super.push(...items);
+    if (length > this.size) {
+      super.splice(0, length - this.size);
+    }
+    return this.length;
+  }
+
+  public unshift(...items: T[]): number {
+    const length = super.unshift(...items);
+    if (length > this.size) {
+      super.splice(this.size, items.length);
+    }
+    return this.length;
   }
 
-  push(...items: T[]): number {
-    if (this.length + items.length > this.size) {
-      super.splice(0, (this.length + items.length) - this.size);
+  public concat(...items: (T | ConcatArray<T>)[]): CircularArray<T> {
+    const concatenatedCircularArray = super.concat(
+      items as T[]
+    ) as CircularArray<T>;
+    concatenatedCircularArray.size = this.size;
+    if (concatenatedCircularArray.length > concatenatedCircularArray.size) {
+      concatenatedCircularArray.splice(
+        0,
+        concatenatedCircularArray.length - concatenatedCircularArray.size
+      );
     }
-    return super.push(...items);
+    return concatenatedCircularArray;
   }
 
-  unshift(...items: T[]): number {
-    if (this.length + items.length > this.size) {
-      super.splice(this.size - items.length, (this.length + items.length) - this.size);
+  public splice(start: number, deleteCount?: number, ...items: T[]): T[] {
+    let itemsRemoved: T[];
+    if (arguments.length >= 3 && typeof deleteCount !== 'undefined') {
+      itemsRemoved = super.splice(start, deleteCount);
+      // FIXME: that makes the items insert not in place
+      this.push(...items);
+    } else if (arguments.length === 2) {
+      itemsRemoved = super.splice(start, deleteCount);
+    } else {
+      itemsRemoved = super.splice(start);
     }
-    return super.unshift(...items);
+    return itemsRemoved;
   }
 
-  concat(...items: (T|ConcatArray<T>)[]): T[] {
-    if (this.length + items.length > this.size) {
-      super.splice(0, (this.length + items.length) - this.size);
+  public resize(size: number): void {
+    this.checkSize(size);
+    if (size === 0) {
+      this.length = 0;
+    } else if (size < this.size) {
+      for (let i = size; i < this.size; i++) {
+        super.pop();
+      }
     }
-    return super.concat(items as T[]);
+    this.size = size;
+  }
+
+  public empty(): boolean {
+    return this.length === 0;
   }
 
-  splice(start: number, deleteCount?: number, ...items: T[]): T[] {
-    this.push(...items);
-    return super.splice(start, deleteCount);
+  public full(): boolean {
+    return this.length === this.size;
+  }
+
+  private checkSize(size: number) {
+    if (size < 0) {
+      throw new RangeError('Invalid circular array size');
+    }
   }
 }