Publish V0.0.2

Author: Selemba1000

README.md

@@ -26,10 +26,10 @@ repositories {
     mavenCentral()
 }
 dependencies{
-    implementation("io.github.selemba1000:JavaMediaTranportControls:0.0.1")
+    implementation("io.github.selemba1000:JavaMediaTranportControls:0.0.2")
 }
 ```
-Current version is 0.0.1.
+Current version is 0.0.2.
 #### Maven Local
 Download this repository via git with:
 ```bash

src/main/java/io/github/selemba1000/JMTC.java

@@ -3,10 +3,19 @@
 import io.github.selemba1000.linux.LinuxJMTC;
 import io.github.selemba1000.windows.WindowsJMTC;
 
+/**
+ * This singleton is the entrypoint to the library. Use getInstance to access the functions of the library
+ */
 public abstract class JMTC {
 
+    /**
+     * Instance reference to implement singleton pattern
+     */
     protected static JMTC INSTANCE;
 
+    /**
+     * Internal constructor to implement singleton pattern.
+     */
     protected JMTC() {
     }
 

src/main/java/io/github/selemba1000/JMTCButtonCallback.java

@@ -2,7 +2,11 @@
 
 /**
  * Interface for callback function for Buttons.
+ * Can be set as Lambda function.
  */
 public interface JMTCButtonCallback {
+    /**
+     * Callback function.
+     */
     void callback();
 }

src/main/java/io/github/selemba1000/JMTCCallbacks.java

@@ -5,6 +5,12 @@
  */
 @SuppressWarnings("CanBeFinal")
 public class JMTCCallbacks {
+    /**
+     * Creates an empty instance to be filled by property access
+     */
+    public JMTCCallbacks() {
+    }
+
     /**
      * Callback for when Play button is pressed in UI or as MediaKey.
      */

src/main/java/io/github/selemba1000/JMTCMediaProperties.java

@@ -4,4 +4,8 @@
  * Abstract class for media properties. Not in Use currently.
  */
 public abstract class JMTCMediaProperties {
+    /**
+     * Create empty instance. Not used directly as class is abstract.
+     */
+    public JMTCMediaProperties(){}
 }

src/main/java/io/github/selemba1000/JMTCMediaType.java

@@ -5,5 +5,8 @@
  * Currently only Music is supported.
  */
 public enum JMTCMediaType {
+    /**
+     * Currently the only supported media type
+     */
     Music,
 }

src/main/java/io/github/selemba1000/JMTCParameters.java

@@ -54,8 +54,17 @@ public JMTCParameters(LoopStatus loopStatus, Double volume, Double rate, Boolean
      * Track = Loop current Track
      */
     public enum LoopStatus {
+        /**
+         * Repeat nothing. Stop after last Song
+         */
         None,
+        /**
+         * Repeat the Playlist after the last song
+         */
         Playlist,
+        /**
+         * Repeat only the currently playing track
+         */
         Track
     }
 }

src/main/java/io/github/selemba1000/JMTCPlayingState.java

@@ -14,10 +14,24 @@
  * Changing = the player is changing the file. Windows only
  */
 public enum JMTCPlayingState {
+    /**
+     * Media is currently playing
+     */
     PLAYING,
+    /**
+     * Media is currently paused
+     */
     PAUSED,
+    /**
+     * Media is stopped. Usually when media was selected, but not started.
+     */
     STOPPED,
+    /**
+     * Currently no media loaded.
+     */
     CLOSED,
+    /**
+     * The Media is currently changing/loading.
+     */
     CHANGING,
-
 }

src/main/java/io/github/selemba1000/JMTCSeekCallback.java

@@ -4,5 +4,9 @@
  * Interface for seek lambda callback.
  */
 public interface JMTCSeekCallback {
+    /**
+     * The callback function.
+     * @param position The position that was seeked to in ms.
+     */
     void callback(Long position);
 }

src/main/java/io/github/selemba1000/JMTCValueChangedCallback.java

@@ -2,9 +2,14 @@
 
 /**
  * Interface for callback when value of property changes.
+ * @param <T> the Type of value that changed
  */
 public interface JMTCValueChangedCallback<T> {
 
+    /**
+     * Callback for when property changes
+     * @param property the property that changed
+     */
     void callback(T property);
 
 }