diff --git a/gdsc-core/src/main/java/uk/ac/sussex/gdsc/core/utils/LocalList.java b/gdsc-core/src/main/java/uk/ac/sussex/gdsc/core/utils/LocalList.java index 8e9ae78f..708b7fa7 100644 --- a/gdsc-core/src/main/java/uk/ac/sussex/gdsc/core/utils/LocalList.java +++ b/gdsc-core/src/main/java/uk/ac/sussex/gdsc/core/utils/LocalList.java @@ -74,7 +74,7 @@ * {@link Cloneable}. The {@link #copy()} and {@link #copyOfRange(int, int)} methods are used to * obtain a storage optimised shallow copy of the list. * - *
Warnings * *
There are methods in this class to supplement the {@link List} API. Some do not have the usual * guarded access to the positions in the list based on the current list size. It is possible to @@ -301,7 +301,7 @@ private void setToNull(int start, int end) { * *
Note: This will silently ignore a negative capacity. * - *
Warning * *
This method may not immediately allocate any storage if the list has been constructed * with the default capacity. In that case storage will be allocated when it is required in @@ -416,7 +416,7 @@ private static int createPositiveCapacity(final int minCapacity) { /** * Get the element at the specified index without checking the current list size. * - *
Warning * *
This method directly reads from the underlying storage and allows access to indices outside * the list size but within the current capacity. It is possible to obtain stale data from the @@ -436,7 +436,7 @@ public E unsafeGet(int index) { /** * Set the element at the specified index without checking the current list size. * - *
Warning * *
This method directly writes to the underlying storage and allows access to indices outside * the list size but within the current capacity. It is possible to create stale references in the @@ -465,7 +465,7 @@ public void unsafeSet(int index, E element) { *
In combination with {@link #pop()} this method creates a last-in-first-out (LIFO) stack data * structure of the current capacity. * - *
Warning * *
This method will throw an exception when {@link #add(Object)} would increase the capacity. * Use {@link #add(Object)} in-place of {@link #push(Object)} for an expandable LIFO stack. @@ -1139,7 +1139,7 @@ public int findLastIndex(Predicate super E> filter) { *
The {@code Spliterator} reports {@link Spliterator#SIZED}, {@link Spliterator#SUBSIZED}, * {@link Spliterator#ORDERED} and {@link Spliterator#IMMUTABLE}. * - *
Warning * *
The {@link LocalList} explicitly ignores concurrency modification checks. The spliterator is
* thus a snapshot of the current list data and it is assumed that modifications to the list will
@@ -1156,7 +1156,7 @@ public Spliterator The iterator does not support the {@link Iterator#remove()} operation. Use the
* {@link #listIterator()} to allow modification of the list via an iterator.
*
- * Warning
*
* The {@link LocalList} explicitly ignores concurrency modification checks. The iterator is
* thus a snapshot of the current list data and it is assumed that modifications to the list will
@@ -1173,7 +1173,7 @@ public Iterator The list iterator supports modification of the list. Use the {@link #iterator()} or
* {@link #forEach(Consumer)} for more efficient traversal of the list.
*
- * Warning
*
* The {@link LocalList} explicitly ignores concurrency modification checks. The list iterator
* can be used to modify the list but must be the sole entity modifying the list. Operation in the
@@ -1190,7 +1190,7 @@ public ListIterator The list iterator supports modification of the list. Use the {@link #iterator()} or
* {@link #forEach(Consumer)} for more efficient traversal of the list.
*
- * Warning
*
* The {@link LocalList} explicitly ignores concurrency modification checks. The list iterator
* can be used to modify the list but must be the sole entity modifying the list. Operation in the
@@ -1207,7 +1207,7 @@ public ListIterator Implementation note
*
* The {@link List} returned by this method does not support detection of concurrent
* modification. The sub-list, and any sub-list thereafter, fully supports the {@link List} API
Warning
+ * Warning
+ * Warning
+ * Implementation note
+ *