mirror of
https://github.com/BentoBoxWorld/BentoBox.git
synced 2024-09-27 06:12:38 +02:00
Removed @throws javadoc tag as it is not needed.
This commit is contained in:
parent
80c2f4178d
commit
9715811303
29
pom.xml
29
pom.xml
@ -61,6 +61,35 @@
|
||||
<target>1.8</target>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-source-plugin</artifactId>
|
||||
<version>3.0.1</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>attach-sources</id>
|
||||
<goals>
|
||||
<goal>jar-no-fork</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>org.apache.maven.plugins</groupId>
|
||||
<artifactId>maven-javadoc-plugin</artifactId>
|
||||
<version>3.0.0</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>attach-javadocs</id>
|
||||
<goals>
|
||||
<goal>jar</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
<configuration>
|
||||
<failOnError>false</failOnError>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
<dependencies>
|
||||
|
@ -67,7 +67,7 @@ public class Metrics {
|
||||
/**
|
||||
* Class constructor.
|
||||
*
|
||||
* @param plugin The plugin which stats should be submitted.
|
||||
* @param plugin - BSkyBlock plugin object The plugin which stats should be submitted.
|
||||
*/
|
||||
public Metrics(JavaPlugin plugin) {
|
||||
if (plugin == null) {
|
||||
|
@ -14,6 +14,8 @@ import org.bukkit.configuration.file.YamlConfiguration;
|
||||
import org.bukkit.event.Listener;
|
||||
|
||||
import us.tastybento.bskyblock.BSkyBlock;
|
||||
import us.tastybento.bskyblock.database.managers.PlayersManager;
|
||||
import us.tastybento.bskyblock.database.managers.island.IslandsManager;
|
||||
|
||||
/**
|
||||
* Add-on class for BSkyBlock. Extend this to create an add-on. The operation
|
||||
@ -231,9 +233,25 @@ public abstract class Addon implements AddonInterface {
|
||||
/**
|
||||
* Set whether this addon is enabled or not
|
||||
*
|
||||
* @param enabled
|
||||
* @param enabled - true if enabled
|
||||
*/
|
||||
public void setEnabled(boolean enabled) {
|
||||
this.enabled = enabled;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Players Manager
|
||||
* @return Players manager
|
||||
*/
|
||||
public PlayersManager getPlayers() {
|
||||
return getBSkyBlock().getPlayers();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Islands Manager
|
||||
* @return Islands manager
|
||||
*/
|
||||
public IslandsManager getIslands() {
|
||||
return getBSkyBlock().getIslands();
|
||||
}
|
||||
}
|
||||
|
@ -18,14 +18,14 @@ public interface PlaceholderAPIInterface {
|
||||
|
||||
/**
|
||||
* Registers the placeholder API
|
||||
* @param plugin
|
||||
* @param plugin - BSkyBlock plugin object
|
||||
* @return true if successfully registered
|
||||
*/
|
||||
boolean register(BSkyBlock plugin);
|
||||
|
||||
/**
|
||||
* Unregisters the placeholder API
|
||||
* @param plugin
|
||||
* @param plugin - BSkyBlock plugin object
|
||||
*/
|
||||
void unregister(BSkyBlock plugin);
|
||||
|
||||
|
@ -29,7 +29,7 @@ public class PlaceholderHandler {
|
||||
|
||||
/**
|
||||
* Register placeholders and hooks
|
||||
* @param plugin
|
||||
* @param plugin - BSkyBlock plugin object
|
||||
*/
|
||||
public static void register(BSkyBlock plugin){
|
||||
|
||||
@ -64,7 +64,7 @@ public class PlaceholderHandler {
|
||||
|
||||
/**
|
||||
* Unregister placeholder hooks
|
||||
* @param plugin
|
||||
* @param plugin - BSkyBlock plugin object
|
||||
*/
|
||||
public static void unregister(BSkyBlock plugin){
|
||||
Iterator<PlaceholderAPIInterface> it = apis.iterator();
|
||||
|
@ -34,9 +34,8 @@ public abstract class BSBDatabase {
|
||||
|
||||
/**
|
||||
* Gets a database handler that will store and retrieve classes of type dataObjectClass
|
||||
* @param plugin
|
||||
* @param dataObjectClass
|
||||
* @return database handler
|
||||
* @param dataObjectClass - class of the object to be stored in the database
|
||||
* @return handler for this database object
|
||||
*/
|
||||
public abstract AbstractDatabaseHandler<?> getHandler(Class<?> dataObjectClass);
|
||||
|
||||
|
@ -15,8 +15,7 @@ public interface DatabaseConnecter {
|
||||
/**
|
||||
* Establishes a new connection to the database
|
||||
*
|
||||
* @return A new connection to the database
|
||||
* @throws SQLException
|
||||
* @return A new connection to the database using the settings provided
|
||||
*/
|
||||
public Connection createConnection() throws SQLException;
|
||||
|
||||
@ -29,26 +28,26 @@ public interface DatabaseConnecter {
|
||||
|
||||
/**
|
||||
* Looks through the database (or files) and returns a known unique key
|
||||
* @param tableName
|
||||
* @param tableName - name of the table
|
||||
* @return a unique key for this record
|
||||
*/
|
||||
public String getUniqueId(String tableName);
|
||||
|
||||
/**
|
||||
* Check if a key exists in the database in this table or not
|
||||
* @param simpleName
|
||||
* @param key
|
||||
* @param tableName - name of the table
|
||||
* @param key - key to check
|
||||
* @return true if it exists
|
||||
*/
|
||||
public boolean uniqueIdExists(String simpleName, String key);
|
||||
public boolean uniqueIdExists(String tableName, String key);
|
||||
|
||||
/**
|
||||
* Loads a YAML file. Used by the flat file database
|
||||
* @param string
|
||||
* @param key
|
||||
* @param tableName - the table name to load
|
||||
* @param fileName - the filename
|
||||
* @return Yaml Configuration
|
||||
*/
|
||||
public YamlConfiguration loadYamlFile(String string, String key);
|
||||
public YamlConfiguration loadYamlFile(String tableName, String fileName);
|
||||
|
||||
/**
|
||||
* Save the Yaml Config
|
||||
|
@ -9,11 +9,11 @@ public class DatabaseConnectionSettingsImpl {
|
||||
|
||||
/**
|
||||
* Hosts database settings
|
||||
* @param host
|
||||
* @param port
|
||||
* @param databaseName
|
||||
* @param username
|
||||
* @param password
|
||||
* @param host - database host
|
||||
* @param port - port
|
||||
* @param databaseName - database name
|
||||
* @param username - username
|
||||
* @param password - password
|
||||
*/
|
||||
public DatabaseConnectionSettingsImpl(String host, int port, String databaseName, String username, String password) {
|
||||
this.host = host;
|
||||
|
@ -39,7 +39,7 @@ public class FlatFileDatabaseConnecter implements DatabaseConnecter {
|
||||
* Loads a YAML file and if it does not exist it is looked for in the JAR
|
||||
*
|
||||
* @param fileName
|
||||
* @return
|
||||
* @return Yaml Config file
|
||||
*/
|
||||
@Override
|
||||
public YamlConfiguration loadYamlFile(String tableName, String fileName) {
|
||||
|
@ -38,7 +38,7 @@ public class PlayersManager{
|
||||
* This is the one-stop-shop of player info
|
||||
* If the player is not cached, then a request is made to Players to obtain it
|
||||
*
|
||||
* @param plugin
|
||||
* @param plugin - BSkyBlock plugin object
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
public PlayersManager(BSkyBlock plugin){
|
||||
|
@ -97,7 +97,7 @@ public class MySQLDatabaseHandler<T> extends AbstractDatabaseHandler<T> {
|
||||
/**
|
||||
* Handles the connection to the database and creation of the initial database schema (tables) for
|
||||
* the class that will be stored.
|
||||
* @param plugin
|
||||
* @param plugin - BSkyBlock plugin object
|
||||
* @param type - the type of class to be stored in the database. Must inherit DataObject
|
||||
* @param databaseConnecter - authentication details for the database
|
||||
*/
|
||||
|
@ -32,7 +32,7 @@ public class Players implements DataObject {
|
||||
public Players() {}
|
||||
|
||||
/**
|
||||
* @param plugin
|
||||
* @param plugin - BSkyBlock plugin object
|
||||
* @param uniqueId
|
||||
* Constructor - initializes the state variables
|
||||
*
|
||||
|
@ -24,7 +24,7 @@ public class ChunkGeneratorWorld extends ChunkGenerator {
|
||||
PerlinOctaveGenerator gen;
|
||||
|
||||
/**
|
||||
* @param plugin
|
||||
* @param plugin - BSkyBlock plugin object
|
||||
*/
|
||||
public ChunkGeneratorWorld(BSkyBlock plugin) {
|
||||
super();
|
||||
|
@ -21,7 +21,7 @@ public class JoinLeaveListener implements Listener {
|
||||
private PlayersManager players;
|
||||
|
||||
/**
|
||||
* @param plugin
|
||||
* @param plugin - BSkyBlock plugin object
|
||||
*/
|
||||
public JoinLeaveListener(BSkyBlock plugin) {
|
||||
this.plugin = plugin;
|
||||
|
@ -40,7 +40,7 @@ public abstract class AbstractFlagListener implements Listener {
|
||||
|
||||
/**
|
||||
* Used for unit testing only to set the plugin
|
||||
* @param plugin
|
||||
* @param plugin - BSkyBlock plugin object
|
||||
*/
|
||||
public void setPlugin(BSkyBlock plugin) {
|
||||
this.plugin = plugin;
|
||||
|
@ -34,7 +34,7 @@ public class FlyingMobEvents implements Listener {
|
||||
private WeakHashMap<Entity, Island> mobSpawnInfo;
|
||||
|
||||
/**
|
||||
* @param plugin
|
||||
* @param plugin - BSkyBlock plugin object
|
||||
*/
|
||||
public FlyingMobEvents(BSkyBlock plugin) {
|
||||
this.plugin = plugin;
|
||||
|
@ -25,7 +25,7 @@ public class RanksManager {
|
||||
private LinkedHashMap<String, Integer> ranks = new LinkedHashMap<>();
|
||||
|
||||
/**
|
||||
* @param plugin
|
||||
* @param plugin - BSkyBlock plugin object
|
||||
*/
|
||||
public RanksManager(BSkyBlock plugin) {
|
||||
super();
|
||||
|
@ -20,7 +20,7 @@ public class DeleteIslandChunks {
|
||||
|
||||
/**
|
||||
* Deletes the island
|
||||
* @param plugin
|
||||
* @param plugin - BSkyBlock plugin object
|
||||
* @param island
|
||||
*/
|
||||
public DeleteIslandChunks(final BSkyBlock plugin, final Island island) {
|
||||
|
Loading…
Reference in New Issue
Block a user