Updating for Java 11

Also continuing updates to take advantage of the newer
Java version we build against, fix typos in documentation, and
switch to explicit API annotations to indicate project entry
points.

src/main/java/org/deepsymmetry/beatlink/data/MetadataProvider.java

@@ -1,5 +1,6 @@
 package org.deepsymmetry.beatlink.data;
 
+import org.apiguardian.api.API;
 import org.deepsymmetry.beatlink.MediaDetails;
 import org.deepsymmetry.cratedigger.pdb.RekordboxAnlz;
 
@@ -12,7 +13,7 @@
  *
  * @since 0.5.0
  */
-@SuppressWarnings("WeakerAccess")
+@API(status = API.Status.STABLE)
 public interface MetadataProvider {
     /**
      * Get the list of media devices for which metadata can be offered by this provider. If the provider can
@@ -34,6 +35,7 @@ public interface MetadataProvider {
      *
      * @return the metadata corresponding to that track, or {@code null} if it is not a track for which we have metadata
      */
+    @API(status = API.Status.STABLE)
     TrackMetadata getTrackMetadata(MediaDetails sourceMedia, DataReference track);
 
     /**
@@ -46,6 +48,7 @@ public interface MetadataProvider {
      *
      * @return the art with the specified id, or {@code null} if we don't have it to offer
      */
+    @API(status = API.Status.STABLE)
     AlbumArt getAlbumArt(MediaDetails sourceMedia, DataReference art);
 
     /**
@@ -58,6 +61,7 @@ public interface MetadataProvider {
      *
      * @return the beat grid corresponding to that track, or {@code null} if we don't have one to offer
      */
+    @API(status = API.Status.STABLE)
     BeatGrid getBeatGrid(MediaDetails sourceMedia, DataReference track);
 
 
@@ -70,6 +74,7 @@ public interface MetadataProvider {
      *
      * @return the cue list corresponding to that track, or {@code null} if we don't have one to offer
      */
+    @API(status = API.Status.STABLE)
     CueList getCueList(MediaDetails sourceMedia, DataReference track);
 
     /**
@@ -82,6 +87,7 @@ public interface MetadataProvider {
      *
      * @return the waveform preview corresponding to that track, or {@code null} if we don't have one to offer
      */
+    @API(status = API.Status.STABLE)
     WaveformPreview getWaveformPreview(MediaDetails sourceMedia, DataReference track);
 
     /**
@@ -94,6 +100,7 @@ public interface MetadataProvider {
      *
      * @return the waveform detail corresponding to that track, or {@code null} if we don't have one to offer
      */
+    @API(status = API.Status.STABLE)
     WaveformDetail getWaveformDetail(MediaDetails sourceMedia, DataReference track);
 
     /**
@@ -109,5 +116,6 @@ public interface MetadataProvider {
      *
      * @return the Kaitai Struct object representing the parsed matching section of the file, if one is found.
      */
+    @API(status = API.Status.STABLE)
     RekordboxAnlz.TaggedSection getAnalysisSection(MediaDetails sourceMedia, DataReference track, String fileExtension, String typeTag);
 }

src/main/java/org/deepsymmetry/beatlink/data/MountListener.java

@@ -1,5 +1,7 @@
 package org.deepsymmetry.beatlink.data;
 
+import org.apiguardian.api.API;
+
 /**
  * <p>The listener interface for receiving updates when the set of mounted media slots on the network changes.</p>
  *
@@ -12,21 +14,22 @@
  *
  * @author James Elliott
  */
-@SuppressWarnings("WeakerAccess")
+@API(status = API.Status.STABLE)
 public interface MountListener {
 
     /**
      * Report that media is newly available in the specified player slot.
      *
      * @param slot uniquely identifies a media slot on the network.
      */
-    @SuppressWarnings("EmptyMethod")
+    @API(status = API.Status.STABLE)
     void mediaMounted(SlotReference slot);
 
     /**
      * Report that media is no longer available in the specified player slot.
      *
      * @param slot uniquely identifies a media slot on the network.
      */
+    @API(status = API.Status.STABLE)
     void mediaUnmounted(SlotReference slot);
 }

src/main/java/org/deepsymmetry/beatlink/data/OpusProvider.java

@@ -30,7 +30,7 @@
  *
  * @author James Elliott
  * @since 8.0.0 */
-@API(status = API.Status.STABLE)  // TODO get rid of all IntelliJ code pattern entry points and @SuppressWarnings annotations, use this instead.
+@API(status = API.Status.EXPERIMENTAL)  // TODO get rid of all IntelliJ code pattern entry points and @SuppressWarnings annotations, use this instead.
 public class OpusProvider {
 
     private static final Logger logger = LoggerFactory.getLogger(OpusProvider.class);
@@ -58,6 +58,7 @@ public boolean isRunning() {
     /**
      * Container for the USB slot number, database and filesystem of any particular Rekordbox USB archive.
      */
+    @API(status = API.Status.EXPERIMENTAL)
     public static class RekordboxUsbArchive {
         private final int usbSlot;
         private final Database database;
@@ -81,6 +82,7 @@ private RekordboxUsbArchive(int usbSlot, Database database, FileSystem fileSyste
          *
          * @return the USB slot on the Opus Quad to which the user has reported this metadata belongs
          */
+        @API(status = API.Status.EXPERIMENTAL)
         public int getUsbSlot() {
             return usbSlot;
         }
@@ -90,6 +92,7 @@ public int getUsbSlot() {
          *
          * @return the parsed database which contains information about tracks, artwork, etc.
          */
+        @API(status = API.Status.EXPERIMENTAL)
         public Database getDatabase() {
             return database;
         }
@@ -99,6 +102,7 @@ public Database getDatabase() {
          *
          * @return the filesystem which contains the database and other metadata
          */
+        @API(status = API.Status.EXPERIMENTAL)
         public FileSystem getFileSystem() {
             return fileSystem;
         }
@@ -122,7 +126,7 @@ public FileSystem getFileSystem() {
      * @throws java.io.IOException if there is a problem attaching the archive
      * @throws IllegalArgumentException if a slot other than the SD or USB slot is specified
      */
-    @API(status = API.Status.STABLE)
+    @API(status = API.Status.EXPERIMENTAL)
     public synchronized void attachMetadataArchive(File archiveFile, int usbSlotNumber) throws IOException {
         if (usbSlotNumber < 1 || usbSlotNumber > 3) {
             throw new IllegalArgumentException("Unsupported usbSlotNumber, can only use 1, 2 or 3.");
@@ -197,7 +201,7 @@ public synchronized void attachMetadataArchive(File archiveFile, int usbSlotNumb
      *
      * @throws IllegalArgumentException if a slot reference other than the SD or USB slot is specified
      */
-    @API(status = API.Status.STABLE)
+    @API(status = API.Status.EXPERIMENTAL)
     public RekordboxUsbArchive findArchive(int usbSlotNumber) {
         return usbArchiveMap.get(usbSlotNumber);
     }
@@ -314,7 +318,7 @@ private RekordboxAnlz findTrackAnalysis(int usbSlotNumber, DataReference track,
      * This is the mechanism by which we offer metadata to the {@link MetadataProvider} while we are running.
      * Exposed as public so that it can be used for testing and as a utility if desired.
      */
-    @API(status = API.Status.STABLE)
+    @API(status = API.Status.EXPERIMENTAL)
     public final MetadataProvider metadataProvider = new MetadataProvider() {
         @Override
         public List<MediaDetails> supportedMedia() {
@@ -563,6 +567,7 @@ private boolean trackMatchesArchive(DataReference dataRef, ByteBuffer pssiFromOp
      * @param songStructureBytes the PSSI data we have received for the player
      * @return the USB slot number in which a match was found, or zero if none was found
      */
+    @API(status = API.Status.EXPERIMENTAL)
     public int findMatchingUsbSlotForTrack(int rekordboxId, int player, ByteBuffer songStructureBytes){
         SlotReference slotRef = SlotReference.getSlotReference(player, CdjStatus.TrackSourceSlot.USB_SLOT);
         DataReference dataRef = new DataReference(slotRef, rekordboxId);
@@ -615,7 +620,7 @@ public static OpusProvider getInstance() {
     /**
      * The folder into which database exports and track analysis files will be extracted.
      */
-    @API(status = API.Status.STABLE)
+    @API(status = API.Status.EXPERIMENTAL)
     public final File extractDirectory;
 
     /**

src/main/java/org/deepsymmetry/beatlink/data/OverlayPainter.java

@@ -1,19 +1,22 @@
 package org.deepsymmetry.beatlink.data;
 
+import org.apiguardian.api.API;
+
 import java.awt.*;
 
 /**
  * In order to make it easy for applications like Beat Link Trigger to overlay selections or cues on the GUI
  * components offered by Beat Link, they allow an overlay painter to be registered with them, and it will then
  * be invoked after the component has done its own painting.
  */
-@SuppressWarnings("WeakerAccess")
+@API(status = API.Status.STABLE)
 public interface OverlayPainter {
     /**
      * Paint the overlay on top of the component, which has finished doing its own painting.
      *
      * @param c the component that has just painted itself
      * @param g the graphics content in which painting is taking place
      */
+    @API(status = API.Status.STABLE)
     void paintOverlay(Component c, Graphics g);
 }

src/main/java/org/deepsymmetry/beatlink/data/PlaybackState.java

@@ -1,23 +1,29 @@
 package org.deepsymmetry.beatlink.data;
 
+import org.apiguardian.api.API;
+
 /**
  * Captures the playback state of a single player that has the track loaded, as an immutable value class.
  */
+@API(status = API.Status.STABLE)
 public class PlaybackState {
 
     /**
      * The player number whose playback state this represents.
      */
+    @API(status = API.Status.STABLE)
     public final int player;
 
     /**
      * The current playback position of the player in milliseconds.
      */
+    @API(status = API.Status.STABLE)
     public final long position;
 
     /**
      * Whether the player is actively playing the track.
      */
+    @API(status = API.Status.STABLE)
     public final boolean playing;
 
     /**
@@ -27,7 +33,7 @@ public class PlaybackState {
      * @param position the current playback position in milliseconds
      * @param playing whether the player is actively playing the track
      */
-    @SuppressWarnings("WeakerAccess")
+    @API(status = API.Status.STABLE)
     public PlaybackState(int player, long position, boolean playing) {
         this.player = player;
         this.position = position;

src/main/java/org/deepsymmetry/beatlink/data/RepaintDelegate.java

@@ -1,5 +1,7 @@
 package org.deepsymmetry.beatlink.data;
 
+import org.apiguardian.api.API;
+
 /**
  * Supports delegation of Swing repaint calls to a host component. This is currently used by the
  * {@link WaveformPreviewComponent} to operate in a soft-loaded manner in user interfaces which display
@@ -9,7 +11,7 @@
  * used along with {@link WaveformPreviewComponent#setRepaintDelegate(RepaintDelegate)} to enable those
  * changes to be communicated to the lighter component which is hosting it.
  */
-@SuppressWarnings("WeakerAccess")
+@API(status = API.Status.STABLE)
 public interface RepaintDelegate {
 
     /**
@@ -22,6 +24,7 @@ public interface RepaintDelegate {
      * @param width the width of the region that we want to have redrawn
      * @param height the height of the region that we want to have redrawn
      */
+    @API(status = API.Status.STABLE)
     void repaint(int x, int y, int width, int height);
 
 }

src/main/java/org/deepsymmetry/beatlink/data/SearchableItem.java

@@ -1,25 +1,29 @@
 package org.deepsymmetry.beatlink.data;
 
+import org.apiguardian.api.API;
+
 /**
- * Represents an item with an ID and label that can be used as a way to select tracks in a dynamic playlist request,
+ * <p>Represents an item with an ID and label that can be used as a way to select tracks in a dynamic playlist request,
  * and on which playlists can be sorted. Many track metadata entries, like artist, genre, and the color labels,
- * are represented this way.
+ * are represented this way.</p>
  *
- * A simple immutable value class.
+ * <p>A simple immutable value class.</p>
  *
  * @author James Elliott
  */
-@SuppressWarnings("WeakerAccess")
+@API(status = API.Status.STABLE)
 public class SearchableItem {
 
     /**
      * The database ID associated with this item, for searches.
      */
+    @API(status = API.Status.STABLE)
     public final int id;
 
     /**
      * The text label used to show this item to the user.
      */
+    @API(status = API.Status.STABLE)
     public final String label;
 
     /**
@@ -28,6 +32,7 @@ public class SearchableItem {
      * @param id the database ID associated with this item, for searches
      * @param label, the text label used to show this item to the user
      */
+    @API(status = API.Status.STABLE)
     public SearchableItem(int id, String label) {
         this.id = id;
         this.label = label;
@@ -45,7 +50,6 @@ public int hashCode() {
         return result;
     }
 
-    @SuppressWarnings("BooleanMethodIsAlwaysInverted")
     @Override
     public boolean equals(Object obj) {
         if (obj == this) {