Merge pull request #27 from DevotedMC/ProgrammerDan-patch-2

README updates based on changes to ACivMod

Author: ProgrammerDan

README.md

@@ -3,6 +3,8 @@ CivModCore
 
 Versions:
 
+* 1.7.5 - Spigot 1.14.4 (No explicit support for 1.14 prior to 1.14.4)
+
 * 1.7.0 - Spigot 1.13.2 (No explicit support for 1.13 or 1.13.1)
 
 * 1.6.1 - Spigot 1.12 (Mercury Removed -- incompatible with plugins that rely on Mercury hooks)
@@ -25,16 +27,10 @@ To use CivModCore, your Main Plugin class must extend ACivMod:
     {
 
     }
-
-In addition to that, you must override getPluginName for log messages:
-
-    protected String getPluginName() {
-        return "MyPluginsName";
-    }
 
 CivModCore implements onEnable/onLoad, and as such an extending plugin must Override and call super:
 
-https://github.com/Bergecraft/CivModCore/blob/master/src/vg/civcraft/mc/civmodcore/ACivMod.java#L108
+https://github.com/DevotedMC/CivModCore/blob/master/src/main/java/vg/civcraft/mc/civmodcore/ACivMod.java#L34
 
     @Override
     public void onEnable()

src/main/java/vg/civcraft/mc/civmodcore/ACivMod.java

@@ -122,7 +122,7 @@ public void info(String message, Object... vars) {
 	}
 
 	/**
-	 * Live activatable debug message (using {@link Config#DebugLog} to decide) at
+	 * Live activatable debug message (using plugin's config.yml top level debug tag to decide) at
 	 * INFO level.
 	 *
 	 * Skipped if DebugLog is false.
@@ -134,7 +134,7 @@ public void debug(String message) {
 	}
 
 	/**
-	 * Live activatable debug message (using {@link Config#DebugLog} to decide) at
+	 * Live activatable debug message (using plugin's config.yml top level debug tag to decide) at
 	 * INFO level with ellipsis notation shorcut for defered injection argument
 	 * array.
 	 *

src/main/java/vg/civcraft/mc/civmodcore/dao/ConnectionPool.java

@@ -37,7 +37,7 @@ public class ConnectionPool {
 	 * @param database
 	 *            The database to use
 	 * @param poolSize
-	 *            The maximum size of the connection pool (< 10 recommended)
+	 *            The maximum size of the connection pool (under 10 recommended)
 	 * @param connectionTimeout
 	 *            The longest a query can run until timeout occurs (1-5s recommended)
 	 * @param idleTimeout

src/main/java/vg/civcraft/mc/civmodcore/dao/ManagedDatasource.java

@@ -33,25 +33,36 @@
  * 
  * To convert existing plugins, do the following:
  *
- * 1. Take existing database version code and refactor it. a. Any CREATE, UPDATE, ALTER, or similar statements, convert
+ * <ol><li> Take existing database version code and refactor it.
+ * <ol><li> Any CREATE, UPDATE, ALTER, or similar statements, convert
  * to a List of Strings and pass them into ManagedDatasource as a Migration using
- * {@link #registerMigration(Integer, boolean, String...)} b. Find your prepared statements. Convert the string
- * resources as static final in your plugin's DAO layer. c. Remove any "is database alive" check code. It's not needed.
- * d. Remove any version management code that remains e. DO react to the results of the {@link #upgradeDatabase} call.
- * i. If false is returned, terminate your plugin. ii. If false is returned and your plugin is critical to a host of
- * other plugins, terminate the server. iii. If an Exception is thrown, I strongly recommend you consider it a "false"
- * return value and react accordingly. f. Note: Create a "first" migration at index -1 that ignores errors and copies
+ * {@link #registerMigration(int, boolean, String...)}</li>
+ * <li>Find your prepared statements. Convert the string resources as static final in your plugin's DAO layer.</li>
+ * <li>Remove any "is database alive" check code. It's not needed.</li>
+ * <li>Remove any version management code that remains</li>
+ * <li>DO react to the results of the {@link #updateDatabase} call.
+ * <ol><li> If false is returned, terminate your plugin. <li>
+ * <li>If false is returned and your plugin is critical to a host of other plugins, terminate the server.</li>
+ * <li>If an Exception is thrown, I strongly recommend you consider it a "false" return value and react 
+ * accordingly.</li></ol></li>
+ * <li>Note: Create a "first" migration at index -1 that ignores errors and copies
  * any "current" migration state data from the db_version or equivalent table into the <code>managed_plugin_data</code>
- * table. 2. Throughout your plugin, ensure that PreparedStatements are "created" new each request and against a newly
+ * table.</li></ol></li>
+ * <li>Throughout your plugin, ensure that PreparedStatements are "created" new each request and against a newly
  * retrieved Connection (using {@link #getConnection()} of this class). Don't worry about PrepareStatements. The driver
- * will manage caching them efficiently. 3. Make sure you release Connections using {@link Connection#close()} as soon
- * as you can (when done with them). a. Don't hold on to Connections. b. Close them. c. Use "try-with-resources"
- * where-ever possible so that they are auto-closed. 4. If you have loops to insert a bunch of similar records, convert
- * it to a batch. Find instructions in {@link #ManagedDatasource}. 5. If you have special needs like atomic
+ * will manage caching them efficiently.</li>
+ * <li>Make sure you release Connections using {@link Connection#close()} as soon as you can 
+ * (when done with them).
+ * <ol><li>Don't hold on to Connections.</li>
+ * <li>Close them.</li>
+ * <li>Use "try-with-resources" where-ever possible so that they are auto-closed.</li></ol></li>
+ * <li>If you have loops to insert a bunch of similar records, convert
+ * it to a batch. Find instructions in {@link #ManagedDatasource}.</li>
+ * <li>If you have special needs like atomic
  * multi-statement, do all your work on a single Connection and return it to a clean state when you are done. (turn
- * auto-commit back on, ensure all transactions are committed, etc.)
+ * auto-commit back on, ensure all transactions are committed, etc.)</li></ol>
  *
- * That should cover most cases. Note that points 2 & 3 are critical. Point 1 is required. Point 4 and 5 are highly
+ * That should cover most cases. Note that points 2 and 3 are critical. Point 1 is required. Point 4 and 5 are highly
  * recommended.
  * 
  * @author ProgrammerDan

src/main/java/vg/civcraft/mc/civmodcore/dao/package-info.java

@@ -3,12 +3,12 @@
  * 
  * Wraps HikariCP for easy connection pooling.
  * 
- * Plugins should use the {@lnk ManagedDatasource} class. 
+ * Plugins should use the {@link ManagedDatasource} class. 
  * 
  * If you know what you're doing and know that the Managed class isn't fit for you,
  * you can directly leverage {@link ConnectionPool}.
  * 
  * @author ProgrammerDan
  *
  */
-package vg.civcraft.mc.civmodcore.dao;
+package vg.civcraft.mc.civmodcore.dao;

src/main/java/vg/civcraft/mc/civmodcore/locations/chunkmeta/ChunkMeta.java

@@ -94,7 +94,7 @@ public World getWorld() {
 	 * Sets the cache state, which specifies whether this instance has changed since
 	 * it was last synced with the database and needs to be written back there
 	 * 
-	 * @param dirty New dirty state
+	 * @param state New dirty state
 	 */
 	public void setCacheState(CacheState state) {
 		this.cacheState = this.cacheState.progress(state);

src/main/java/vg/civcraft/mc/civmodcore/locations/chunkmeta/api/ChunkMetaAPI.java

@@ -28,8 +28,8 @@ public class ChunkMetaAPI {
 	 * 
 	 * @param <T>               BlockBasedChunkMeta subclass
 	 * @param <D>               BlockDataObject subclass
+	 * @param <S>               StorageEngine subclass
 	 * @param plugin            Your plugin
-	 * @param chunkMetaClass    BlockBasedChunkMeta subclass class object
 	 * @param emptyChunkCreator Lambda supplying new empty instances of your
 	 *                          BlockBasedChunkMeta class
 	 * @return API access object for block based chunk metadata

src/main/java/vg/civcraft/mc/civmodcore/locations/chunkmeta/api/ChunkMetaView.java

@@ -95,7 +95,7 @@ public T getChunkMeta(Chunk chunk) {
 	 * Retrieves chunk metadata for the given chunk with the given for this specific
 	 * plugin
 	 * 
-	 * @param chunk Chunk to get metadata for
+	 * @param location Location of the chunk to get metadata for
 	 * @return ChunkMeta for the requested chunk owned by this plugin, possibly null
 	 *         if no such data exists yet
 	 */

src/main/java/vg/civcraft/mc/civmodcore/locations/chunkmeta/block/BlockBasedChunkMeta.java

@@ -233,7 +233,7 @@ public final void put(Location location, D blockData) {
 	/**
 	 * Removes the entry at the given block if one exists and returns it
 	 * 
-	 * @param location Block to remove data from, may not be null
+	 * @param block Block to remove data from, may not be null
 	 */
 	public final D remove(Block block) {
 		if (block == null) {

src/main/java/vg/civcraft/mc/civmodcore/ratelimiting/RateLimiter.java

@@ -50,7 +50,7 @@ public boolean pullToken(UUID uuid) {
 	/**
 	 * Attempts to pull a token for the player with the given UUID
 	 * 
-	 * @param uuid UUID of the player
+	 * @param player Bukkit Player object for the player
 	 * @return True if a token was available and successfully consumed, false
 	 *         otherwise
 	 */