Throw exception in circular buffer for invalid operations

wpilibsuite · Nov 27, 2023 · 340d013 · 340d013
1 parent cbbeab2
commit 340d013
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/wpiutil/src/main/java/edu/wpi/first/util/CircularBuffer.java b/wpiutil/src/main/java/edu/wpi/first/util/CircularBuffer.java
@@ -46,12 +46,13 @@ public T getFirst() {
    * Get value at back of buffer.
    *
    * @return value at back of buffer
+   * @throws IndexOutOfBoundsException if the index is out of range (index < 0 || index >= size())
    */
   @SuppressWarnings("unchecked")
   public T getLast() {
     // If there are no elements in the buffer, do nothing
     if (m_length == 0) {
-      return (T) new Object();
+      throw new IndexOutOfBoundsException();
     }
 
     return m_data[(m_front + m_length - 1) % m_data.length];
@@ -102,12 +103,13 @@ public void addLast(T value) {
    * Pop value at front of buffer.
    *
    * @return value at front of buffer
+   * @throws IndexOutOfBoundsException if the index is out of range (index < 0 || index >= size())
    */
   @SuppressWarnings("unchecked")
   public T removeFirst() {
     // If there are no elements in the buffer, do nothing
     if (m_length == 0) {
-      return (T) new Object();
+      throw new IndexOutOfBoundsException();
     }
 
     T temp = m_data[m_front];
@@ -120,12 +122,13 @@ public T removeFirst() {
    * Pop value at back of buffer.
    *
    * @return value at back of buffer
+   * @throws IndexOutOfBoundsException if the index is out of range (index < 0 || index >= size())
    */
   @SuppressWarnings("unchecked")
   public T removeLast() {
     // If there are no elements in the buffer, do nothing
     if (m_length == 0) {
-      return (T) new Object();
+      throw new IndexOutOfBoundsException();
     }
 
     m_length--;