Completed javadocs

koca2000 · koca2000 · commit adb5e00b3cec · 2018-08-06T21:52:41.000+02:00
diff --git a/README.md b/README.md
@@ -2,4 +2,5 @@
 [![](https://jitpack.io/v/koca2000/NoteBlockAPI.svg)](https://jitpack.io/#koca2000/NoteBlockAPI) [![Build Status](http://ci.haprosgames.com/buildStatus/icon?job=NoteBlockAPI)](http://ci.haprosgames.com/job/NoteBlockAPI)
 
 For information about this Spigot/Bukkit API, go to https://www.spigotmc.org/resources/noteblockapi.19287/
-Dev builds are available at [Jenkins](http://ci.haprosgames.com/job/NoteBlockAPI/ "Jenkins")
+
+Dev builds are available at [Jenkins](http://ci.haprosgames.com/job/NoteBlockAPI/ "Jenkins")
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/CompatibilityUtils.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/CompatibilityUtils.java
@@ -10,8 +10,7 @@
 import org.bukkit.entity.Player;
 
 /**
- * Fields/methods for reflection & version checking
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.utils.CompatibilityUtils}
  */
 @Deprecated
 public class CompatibilityUtils {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/CustomInstrument.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/CustomInstrument.java
@@ -3,8 +3,7 @@
 import com.xxmicloxx.NoteBlockAPI.model.Sound;
 
 /**
- * Create custom instruments from a sound file
- * 
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.model.CustomInstrument}
  */
 @Deprecated
 public class CustomInstrument{
@@ -55,7 +54,7 @@ public org.bukkit.Sound getSound() {
 	
 	/**
 	 * Gets file name of the sound
-	 * @deprecated misleading name
+	 * @deprecated misleading name.
 	 */
 	public String getSoundfile() {
 		return soundFileName;
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/FadeType.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/FadeType.java
@@ -1,5 +1,8 @@
 package com.xxmicloxx.NoteBlockAPI;
 
+/**
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.model.FadeType}
+ */
 @Deprecated
 public enum FadeType {
 
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/Instrument.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/Instrument.java
@@ -3,8 +3,7 @@
 import com.xxmicloxx.NoteBlockAPI.model.Sound;
 
 /**
- * Various methods for working with instruments
- * @deprecated Moved to InstrumentUtils
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.utils.InstrumentUtils}
  */
 @Deprecated
 public class Instrument {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/Interpolator.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/Interpolator.java
@@ -19,6 +19,7 @@
  *          <p/>
  *          <font size="-1" color="#336699">Copyright 2002 MBARI.<br>
  *          MBARI Proprietary Information. All rights reserved.</font><br><hr><br>
+ * @deprecated {@link com.xxmicloxx.NoteBlockAPI.utils.Interpolator}
  */
 @Deprecated
 public class Interpolator {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/Layer.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/Layer.java
@@ -3,9 +3,7 @@
 import java.util.HashMap;
 
 /**
- * Represents a series of notes in Note Block Studio. 
- * A Layer can have a maximum of one note per tick (20 ticks a second)
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.model.Layer}
  */
 @Deprecated
 public class Layer{
@@ -74,7 +72,7 @@ public HashMap<Integer, Note> getHashMap() {
 	 */
 	@Deprecated
 	public void setHashMap(HashMap<Integer, Note> hashMap) {
-		this.notesAtTicks = notesAtTicks;
+		this.notesAtTicks = hashMap;
 	}
 	
 }
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/NBSDecoder.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/NBSDecoder.java
@@ -17,8 +17,7 @@
 import com.xxmicloxx.NoteBlockAPI.utils.InstrumentUtils;
 
 /**
- * Utils for reading Note Block Studio data
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.utils.NBSDecoder}
  */
 @Deprecated
 public class NBSDecoder {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/Note.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/Note.java
@@ -1,9 +1,7 @@
 package com.xxmicloxx.NoteBlockAPI;
 
 /**
- * Represents a note played; contains the instrument and the key
- * @see NotePitch
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.model.Note}
  */
 @Deprecated
 public class Note {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/NoteBlockAPI.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/NoteBlockAPI.java
@@ -4,7 +4,6 @@
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.Set;
 import java.util.UUID;
 
 import org.bstats.bukkit.Metrics;
@@ -15,6 +14,9 @@
 
 import com.xxmicloxx.NoteBlockAPI.songplayer.SongPlayer;
 
+/**
+ * Main class; contains methods for playing and adjusting songs for players
+ */
 public class NoteBlockAPI extends JavaPlugin {
 
 	private static NoteBlockAPI plugin;
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/NoteBlockPlayerMain.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/NoteBlockPlayerMain.java
@@ -9,8 +9,7 @@
 import org.bukkit.entity.Player;
 
 /**
- * Main class; contains methods for playing and adjusting songs for players
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.NoteBlockAPI}
  */
 @Deprecated
 public class NoteBlockPlayerMain {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/NoteBlockSongPlayer.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/NoteBlockSongPlayer.java
@@ -5,12 +5,10 @@
 import org.bukkit.block.Block;
 import org.bukkit.entity.Player;
 
-import com.xxmicloxx.NoteBlockAPI.songplayer.RangeSongPlayer;
 import com.xxmicloxx.NoteBlockAPI.utils.InstrumentUtils;
 
 /**
- * SongPlayer created at a specified NoteBlock
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.songplayer.NoteBlockSongPlayer}
  */
 @Deprecated
 public class NoteBlockSongPlayer extends SongPlayer {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/NotePitch.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/NotePitch.java
@@ -3,8 +3,7 @@
 import org.bukkit.Bukkit;
 
 /**
- * Represents pitches of every noteblock note pre- & post-1.9
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.model.NotePitch}
  */
 @Deprecated
 public enum NotePitch {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/PlayerRangeStateChangeEvent.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/PlayerRangeStateChangeEvent.java
@@ -5,8 +5,7 @@
 import org.bukkit.event.HandlerList;
 
 /**
- * Called whenever a Player enters the range of a stationary SongPlayer
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.event.PlayerRangeStateChangeEvent}
  */
 @Deprecated
 public class PlayerRangeStateChangeEvent extends Event {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/PositionSongPlayer.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/PositionSongPlayer.java
@@ -2,14 +2,12 @@
 
 import org.bukkit.Bukkit;
 import org.bukkit.Location;
-import org.bukkit.block.Block;
 import org.bukkit.entity.Player;
 
 import com.xxmicloxx.NoteBlockAPI.utils.InstrumentUtils;
 
 /**
- * SongPlayer created at a specified Location
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.songplayer.PositionSongPlayer}
  */
 @Deprecated
 public class PositionSongPlayer extends SongPlayer {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/RadioSongPlayer.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/RadioSongPlayer.java
@@ -5,8 +5,7 @@
 import com.xxmicloxx.NoteBlockAPI.utils.InstrumentUtils;
 
 /**
- * SongPlayer created at a Player's location
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.songplayer.RadioSongPlayer}
  */
 @Deprecated
 public class RadioSongPlayer extends SongPlayer {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/Song.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/Song.java
@@ -4,8 +4,7 @@
 import java.util.HashMap;
 
 /**
- * Represents a Note Block Studio project
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.model.Song}
  */
 @Deprecated
 public class Song implements Cloneable {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/SongDestroyingEvent.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/SongDestroyingEvent.java
@@ -5,9 +5,7 @@
 import org.bukkit.event.HandlerList;
 
 /**
- * Called whenever a Song is destroyed
- * @see SongPlayer
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.event.SongDestroyingEvent}
  */
 @Deprecated
 public class SongDestroyingEvent extends Event implements Cancellable {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/SongEndEvent.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/SongEndEvent.java
@@ -4,10 +4,7 @@
 import org.bukkit.event.HandlerList;
 
 /**
- * Called when a Song ends
- * or when no players are listening and auto destroy is enabled
- * @see SongPlayer
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.event.SongEndEvent}
  */
 @Deprecated
 public class SongEndEvent extends Event {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/SongPlayer.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/SongPlayer.java
@@ -15,8 +15,7 @@
 import org.bukkit.entity.Player;
 
 /**
- * Plays a Song for a list of Players
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.songplayer.SongPlayer}
  */
 @Deprecated
 public abstract class SongPlayer {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/SongStoppedEvent.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/SongStoppedEvent.java
@@ -4,8 +4,7 @@
 import org.bukkit.event.HandlerList;
 
 /**
- * Called whenever a SongPlayer is stopped
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.event.SongStoppedEvent}
  */
 @Deprecated
 public class SongStoppedEvent extends Event {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/SoundCategory.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/SoundCategory.java
@@ -1,8 +1,7 @@
 package com.xxmicloxx.NoteBlockAPI;
 
 /**
- * @see org.bukkit.SoundCategory
- *
+ * @Deprecated {@link com.xxmicloxx.NoteBlockAPI.model.SoundCategory}
  */
 @Deprecated
 public enum SoundCategory {
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/event/PlayerRangeStateChangeEvent.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/event/PlayerRangeStateChangeEvent.java
@@ -7,7 +7,7 @@
 import com.xxmicloxx.NoteBlockAPI.songplayer.SongPlayer;
 
 /**
- * Called whenever a Player enters the range of a stationary SongPlayer
+ * Called whenever a Player enters or leave the range of a stationary SongPlayer
  *
  */
 public class PlayerRangeStateChangeEvent extends Event {
@@ -32,14 +32,26 @@ public HandlerList getHandlers() {
 		return handlers;
 	}
 
+	/**
+	 * Returns SongPlayer which range Player enters or leaves
+	 * @return SongPlayer
+	 */
 	public SongPlayer getSongPlayer() {
 		return song;
 	}
 
+	/**
+	 * Returns Player which enter/leave SongPlayer range
+	 * @return Player
+	 */
 	public Player getPlayer() {
 		return player;
 	}
 
+	/**
+	 * Returns true if Player is actually in SongPlayer range
+	 * @return boolean determining if is Player in SongPlayer range
+	 */
 	public boolean isInRange() {
 		return state;
 	}
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/event/SongDestroyingEvent.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/event/SongDestroyingEvent.java
@@ -7,7 +7,7 @@
 import com.xxmicloxx.NoteBlockAPI.songplayer.SongPlayer;
 
 /**
- * Called whenever a Song is destroyed
+ * Called whenever a SongPlayer is destroyed
  * @see SongPlayer
  *
  */
@@ -25,6 +25,10 @@ public static HandlerList getHandlerList() {
 		return handlers;
 	}
 
+	/**
+	 * Returns SongPlayer which is being destroyed
+	 * @return SongPlayer
+	 */
 	public SongPlayer getSongPlayer() {
 		return song;
 	}
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/event/SongEndEvent.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/event/SongEndEvent.java
@@ -3,6 +3,7 @@
 import org.bukkit.event.Event;
 import org.bukkit.event.HandlerList;
 
+import com.xxmicloxx.NoteBlockAPI.model.Song;
 import com.xxmicloxx.NoteBlockAPI.songplayer.SongPlayer;
 
 /**
@@ -24,6 +25,10 @@ public static HandlerList getHandlerList() {
 		return handlers;
 	}
 
+	/**
+	 * Returns SongPlayer which {@link Song} ends
+	 * @return SongPlayer
+	 */
 	public SongPlayer getSongPlayer() {
 		return song;
 	}
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/event/SongLoopEvent.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/event/SongLoopEvent.java
@@ -1,14 +1,17 @@
 package com.xxmicloxx.NoteBlockAPI.event;
 
+import org.bukkit.event.Cancellable;
 import org.bukkit.event.Event;
 import org.bukkit.event.HandlerList;
 
+import com.xxmicloxx.NoteBlockAPI.model.Song;
 import com.xxmicloxx.NoteBlockAPI.songplayer.SongPlayer;
 
-public class SongLoopEvent extends Event {
+public class SongLoopEvent extends Event implements Cancellable {
 
 	private static final HandlerList handlers = new HandlerList();
 	private SongPlayer song;
+	private boolean cancelled = false;
 
 	public SongLoopEvent(SongPlayer song) {
 		this.song = song;
@@ -18,6 +21,10 @@ public static HandlerList getHandlerList() {
 		return handlers;
 	}
 
+	/**
+	 * Returns SongPlayer which {@link Song} ends and is going to start again
+	 * @return SongPlayer
+	 */
 	public SongPlayer getSongPlayer() {
 		return song;
 	}
@@ -26,4 +33,14 @@ public HandlerList getHandlers() {
 		return handlers;
 	}
 
+	@Override
+	public boolean isCancelled() {
+		return cancelled;
+	}
+
+	@Override
+	public void setCancelled(boolean cancel) {
+		this.cancelled = cancel;
+	}
+
 }
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/event/SongStoppedEvent.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/event/SongStoppedEvent.java
@@ -8,7 +8,7 @@
 
 /**
  * Called whenever a SongPlayer is stopped
- *
+ * @see SongPlayer
  */
 public class SongStoppedEvent extends Event {
 
@@ -23,6 +23,10 @@ public static HandlerList getHandlerList() {
 		return handlers;
 	}
 
+	/**
+	 * Returns SongPlayer which is now stopped
+	 * @return SongPlayer
+	 */	
 	public SongPlayer getSongPlayer() {
 		return songPlayer;
 	}
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/model/FadeType.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/model/FadeType.java
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/model/Note.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/model/Note.java
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/model/Song.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/model/Song.java
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/songplayer/NoteBlockSongPlayer.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/songplayer/NoteBlockSongPlayer.java
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/songplayer/PositionSongPlayer.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/songplayer/PositionSongPlayer.java
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/songplayer/RadioSongPlayer.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/songplayer/RadioSongPlayer.java
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/songplayer/RangeSongPlayer.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/songplayer/RangeSongPlayer.java
diff --git a/src/main/java/com/xxmicloxx/NoteBlockAPI/songplayer/SongPlayer.java b/src/main/java/com/xxmicloxx/NoteBlockAPI/songplayer/SongPlayer.java
