Note that all element manipulation happens via indices. */ -public interface IndirectPriorityQueue { +public interface IndirectPriorityQueue { /** Enqueues a new element. * @@ -116,11 +118,12 @@ default void changed() { changed(first()); } - /** Returns the comparator associated with this queue, or {@code null} if it uses its elements' natural ordering. - * - * @return the comparator associated with this sorted set, or {@code null} if it uses its elements' natural ordering. - */ - Comparator comparator(); + /** + * Returns the comparator associated with this queue, or {@code null} if it uses its elements' natural ordering. + * + * @return the comparator associated with this sorted set, or {@code null} if it uses its elements' natural ordering. + */ + @Nullable Comparator comparator(); /** Notifies this queue that the specified element has changed (optional operation). * diff --git a/src/it/unimi/dsi/fastutil/IndirectPriorityQueues.java b/src/it/unimi/dsi/fastutil/IndirectPriorityQueues.java index 5a57ceb66..c1578cbdb 100644 --- a/src/it/unimi/dsi/fastutil/IndirectPriorityQueues.java +++ b/src/it/unimi/dsi/fastutil/IndirectPriorityQueues.java @@ -16,6 +16,8 @@ package it.unimi.dsi.fastutil; +import org.jspecify.annotations.Nullable; + import java.util.Comparator; import java.util.NoSuchElementException; @@ -60,7 +62,7 @@ public void clear() {} @Override public void allChanged() {} @Override - public Comparator comparator() { return null; } + public @Nullable Comparator comparator() { return null; } @Override public void changed(final int i) { throw new IllegalArgumentException("Index " + i + " is not in the queue"); } @Override @@ -120,7 +122,7 @@ protected SynchronizedIndirectPriorityQueue(final IndirectPriorityQueue q) { @Override public boolean remove(final int i) { synchronized(sync) { return q.remove(i); } } @Override - public Comparator comparator() { synchronized(sync) { return q.comparator(); } } + public @Nullable Comparator comparator() { synchronized(sync) { return q.comparator(); } } @Override public int front(final int[] a) { return q.front(a); } } diff --git a/src/it/unimi/dsi/fastutil/Pair.java b/src/it/unimi/dsi/fastutil/Pair.java index d904cd941..6fb90debb 100644 --- a/src/it/unimi/dsi/fastutil/Pair.java +++ b/src/it/unimi/dsi/fastutil/Pair.java @@ -19,6 +19,7 @@ import java.util.Comparator; import it.unimi.dsi.fastutil.objects.ObjectObjectImmutablePair; +import org.jspecify.annotations.Nullable; /** * A pair of elements. @@ -49,7 +50,7 @@ * @param the type of the right element. */ -public interface Pair { +public interface Pair { /** * Returns the left element of this pair. diff --git a/src/it/unimi/dsi/fastutil/PriorityQueue.java b/src/it/unimi/dsi/fastutil/PriorityQueue.java index 64918cb52..a8163a650 100644 --- a/src/it/unimi/dsi/fastutil/PriorityQueue.java +++ b/src/it/unimi/dsi/fastutil/PriorityQueue.java @@ -16,6 +16,8 @@ package it.unimi.dsi.fastutil; +import org.jspecify.annotations.Nullable; + import java.util.Comparator; import java.util.NoSuchElementException; @@ -36,7 +38,7 @@ * changed its relative position in the order}. */ -public interface PriorityQueue { +public interface PriorityQueue { /** Enqueues a new element. * @@ -98,10 +100,10 @@ default boolean isEmpty() { default void changed() { throw new UnsupportedOperationException(); } - - /** Returns the comparator associated with this queue, or {@code null} if it uses its elements' natural ordering. - * - * @return the comparator associated with this sorted set, or {@code null} if it uses its elements' natural ordering. - */ - Comparator comparator(); + /** + * Returns the comparator associated with this queue, or {@code null} if it uses its elements' natural ordering. + * + * @return the comparator associated with this sorted set, or {@code null} if it uses its elements' natural ordering. + */ + @Nullable Comparator comparator(); } diff --git a/src/it/unimi/dsi/fastutil/PriorityQueues.java b/src/it/unimi/dsi/fastutil/PriorityQueues.java index 14da80944..83ca0da5b 100644 --- a/src/it/unimi/dsi/fastutil/PriorityQueues.java +++ b/src/it/unimi/dsi/fastutil/PriorityQueues.java @@ -16,6 +16,8 @@ package it.unimi.dsi.fastutil; +import org.jspecify.annotations.Nullable; + import java.io.Serializable; import java.util.Comparator; import java.util.NoSuchElementException; @@ -66,7 +68,7 @@ public void clear() {} public void changed() { throw new NoSuchElementException(); } @Override - public Comparator comparator() { return null; } + public @Nullable Comparator comparator() { return null; } @Override public Object clone() { return EMPTY_QUEUE; } @@ -138,7 +140,7 @@ protected SynchronizedPriorityQueue(final PriorityQueue q) { public void changed() { synchronized(sync) { q.changed(); } } @Override - public Comparator comparator() { synchronized(sync) { return q.comparator(); } } + public @Nullable Comparator comparator() { synchronized(sync) { return q.comparator(); } } @Override public String toString() { synchronized(sync) { return q.toString(); } } diff --git a/src/it/unimi/dsi/fastutil/SortedPair.java b/src/it/unimi/dsi/fastutil/SortedPair.java index 7a480b071..6c0b0f495 100644 --- a/src/it/unimi/dsi/fastutil/SortedPair.java +++ b/src/it/unimi/dsi/fastutil/SortedPair.java @@ -20,6 +20,7 @@ import it.unimi.dsi.fastutil.objects.ObjectObjectImmutablePair; import it.unimi.dsi.fastutil.objects.ObjectObjectImmutableSortedPair; +import org.jspecify.annotations.Nullable; /** * A pair of sorted elements. @@ -40,7 +41,7 @@ * @param the type of the elements. */ -public interface SortedPair> extends Pair { +public interface SortedPair> extends Pair { /** * Returns a new immutable {@link it.unimi.dsi.fastutil.SortedPair SortedPair} with given left @@ -55,7 +56,7 @@ public interface SortedPair> extends Pair { * @implNote This factory method delegates to * {@link ObjectObjectImmutablePair#of(Object, Object)}. */ - public static > SortedPair of(final K l, final K r) { + public static > SortedPair of(final K l, final K r) { return ObjectObjectImmutableSortedPair.of(l, r); } @@ -65,7 +66,7 @@ public static > SortedPair of(final K l, final K r) { * @param o an object, or {@code null}- * @return true if one of the two elements of this sorted pair is equal to {@code o}. */ - default boolean contains(final Object o) { + default boolean contains(final @Nullable Object o) { return Objects.equals(o, left()) || Objects.equals(o, right()); } } diff --git a/src/it/unimi/dsi/fastutil/Stack.java b/src/it/unimi/dsi/fastutil/Stack.java index b1907afb9..32fd58fa3 100644 --- a/src/it/unimi/dsi/fastutil/Stack.java +++ b/src/it/unimi/dsi/fastutil/Stack.java @@ -16,6 +16,8 @@ package it.unimi.dsi.fastutil; +import org.jspecify.annotations.Nullable; + import java.util.NoSuchElementException; /** A stack. @@ -30,7 +32,7 @@ * @param the types of elements in the stack. */ -public interface Stack { +public interface Stack { /** Pushes the given object on the stack. * diff --git a/src/it/unimi/dsi/fastutil/io/FastByteArrayInputStream.java b/src/it/unimi/dsi/fastutil/io/FastByteArrayInputStream.java index e0fd9946f..90ce3065c 100644 --- a/src/it/unimi/dsi/fastutil/io/FastByteArrayInputStream.java +++ b/src/it/unimi/dsi/fastutil/io/FastByteArrayInputStream.java @@ -15,6 +15,8 @@ */ package it.unimi.dsi.fastutil.io; +import org.jspecify.annotations.Nullable; + import java.io.DataInputStream; import java.io.IOException; import java.io.ObjectInput; @@ -219,7 +221,7 @@ public double readDouble () { } @Override @Deprecated - public String readLine () { + public @Nullable String readLine () { final StringBuilder sb = new StringBuilder(99); loop: for (int c;;){ @@ -245,7 +247,7 @@ public String readLine () { @Override public String readUTF () throws UTFDataFormatException { try { - return available() > 0 ? DataInputStream.readUTF(this) : null; + return available() > 0 ? DataInputStream.readUTF(this) : null; // FIXME: DataInput.readUTF should be NotNull } catch (final UTFDataFormatException badBinaryFormatting){ throw badBinaryFormatting; } catch (final IOException e){ diff --git a/src/it/unimi/dsi/fastutil/io/InspectableFileCachedInputStream.java b/src/it/unimi/dsi/fastutil/io/InspectableFileCachedInputStream.java index b92a2fc8c..442010046 100644 --- a/src/it/unimi/dsi/fastutil/io/InspectableFileCachedInputStream.java +++ b/src/it/unimi/dsi/fastutil/io/InspectableFileCachedInputStream.java @@ -27,6 +27,7 @@ import java.nio.channels.WritableByteChannel; import it.unimi.dsi.fastutil.bytes.ByteArrays; +import org.jspecify.annotations.Nullable; /** A {@linkplain RepositionableStream repositionable} {@link MeasurableInputStream} based on * cached data received by a {@link WritableByteChannel} whose first bytes can be inspected directly. @@ -95,7 +96,7 @@ public class InspectableFileCachedInputStream extends MeasurableInputStream impl * @param bufferSize the buffer size, in bytes. * @param overflowFile the directory where the overflow file should be created, or {@code null} for the default temporary directory. */ - public InspectableFileCachedInputStream(final int bufferSize, final File overflowFile) throws IOException { + public InspectableFileCachedInputStream(final int bufferSize, final @Nullable File overflowFile) throws IOException { if (bufferSize <= 0) throw new IllegalArgumentException("Illegal buffer size " + bufferSize); if (overflowFile != null) this.overflowFile = overflowFile; else (this.overflowFile = File.createTempFile(getClass().getSimpleName(), "overflow")).deleteOnExit();