Minor: Converters - reduce visibility

- Change fields from public to private
- Make classes package-private where appropriate
- Remove redundant javadoc
This commit is contained in:
ljacqu 2015-12-27 21:21:09 +01:00
parent 25a9b6cb00
commit 68e5f636ae
10 changed files with 24 additions and 114 deletions

View File

@ -578,7 +578,7 @@ public class AuthMe extends JavaPlugin {
if (Settings.getDataSource == DataSource.DataSourceType.FILE) { if (Settings.getDataSource == DataSource.DataSourceType.FILE) {
ConsoleLogger.showError("FlatFile backend has been detected and is now deprecated, it will be changed to SQLite... Connection will be impossible until conversion is done!"); ConsoleLogger.showError("FlatFile backend has been detected and is now deprecated, it will be changed to SQLite... Connection will be impossible until conversion is done!");
ForceFlatToSqlite converter = new ForceFlatToSqlite(database, this); ForceFlatToSqlite converter = new ForceFlatToSqlite(database);
DataSource source = converter.run(); DataSource source = converter.run();
if (source != null) { if (source != null) {
database = source; database = source;

View File

@ -14,13 +14,11 @@ import java.io.IOException;
/** /**
* @author Xephi59 * @author Xephi59
* @version $Revision: 1.0 $
*/ */
public class CrazyLoginConverter implements Converter { public class CrazyLoginConverter implements Converter {
public final AuthMe instance; private final DataSource database;
public final DataSource database; private final CommandSender sender;
public final CommandSender sender;
/** /**
* Constructor for CrazyLoginConverter. * Constructor for CrazyLoginConverter.
@ -29,7 +27,6 @@ public class CrazyLoginConverter implements Converter {
* @param sender CommandSender * @param sender CommandSender
*/ */
public CrazyLoginConverter(AuthMe instance, CommandSender sender) { public CrazyLoginConverter(AuthMe instance, CommandSender sender) {
this.instance = instance;
this.database = instance.database; this.database = instance.database;
this.sender = sender; this.sender = sender;
} }

View File

@ -1,6 +1,5 @@
package fr.xephi.authme.converter; package fr.xephi.authme.converter;
import fr.xephi.authme.AuthMe;
import fr.xephi.authme.ConsoleLogger; import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.cache.auth.PlayerAuth; import fr.xephi.authme.cache.auth.PlayerAuth;
import fr.xephi.authme.datasource.DataSource; import fr.xephi.authme.datasource.DataSource;
@ -13,21 +12,10 @@ public class ForceFlatToSqlite {
private final DataSource data; private final DataSource data;
/** public ForceFlatToSqlite(DataSource data) {
* Constructor for ForceFlatToSqlite.
*
* @param data DataSource
* @param plugin AuthMe
*/
public ForceFlatToSqlite(DataSource data, AuthMe plugin) {
this.data = data; this.data = data;
} }
/**
* Method run.
*
* @see java.lang.Runnable#run()
*/
public DataSource run() { public DataSource run() {
DataSource sqlite = null; DataSource sqlite = null;
try { try {
@ -39,7 +27,7 @@ public class ForceFlatToSqlite {
Settings.setValue("DataSource.backend", "sqlite"); Settings.setValue("DataSource.backend", "sqlite");
ConsoleLogger.info("Database successfully converted to sqlite !"); ConsoleLogger.info("Database successfully converted to sqlite !");
} catch (Exception e) { } catch (Exception e) {
ConsoleLogger.showError("An error occured while trying to convert flatfile to sqlite ..."); ConsoleLogger.showError("An error occurred while trying to convert flatfile to sqlite ...");
return null; return null;
} }
return sqlite; return sqlite;

View File

@ -19,7 +19,6 @@ import java.util.Map.Entry;
/** /**
* @author Xephi59 * @author Xephi59
* @version $Revision: 1.0 $
*/ */
public class RakamakConverter implements Converter { public class RakamakConverter implements Converter {
@ -27,32 +26,16 @@ public class RakamakConverter implements Converter {
public final DataSource database; public final DataSource database;
public final CommandSender sender; public final CommandSender sender;
/**
* Constructor for RakamakConverter.
*
* @param instance AuthMe
* @param sender CommandSender
*/
public RakamakConverter(AuthMe instance, CommandSender sender) { public RakamakConverter(AuthMe instance, CommandSender sender) {
this.instance = instance; this.instance = instance;
this.database = instance.database; this.database = instance.database;
this.sender = sender; this.sender = sender;
} }
/**
* Method getInstance.
*
* @return RakamakConverter
*/
public RakamakConverter getInstance() { public RakamakConverter getInstance() {
return this; return this;
} }
/**
* Method run.
*
* @see java.lang.Runnable#run()
*/
@Override @Override
public void run() { public void run() {
HashAlgorithm hash = Settings.getPasswordHash; HashAlgorithm hash = Settings.getPasswordHash;

View File

@ -8,28 +8,16 @@ import org.bukkit.OfflinePlayer;
import java.io.File; import java.io.File;
/**
*/
public class RoyalAuthConverter implements Converter { public class RoyalAuthConverter implements Converter {
public final AuthMe plugin; private final AuthMe plugin;
private final DataSource data; private final DataSource data;
/**
* Constructor for RoyalAuthConverter.
*
* @param plugin AuthMe
*/
public RoyalAuthConverter(AuthMe plugin) { public RoyalAuthConverter(AuthMe plugin) {
this.plugin = plugin; this.plugin = plugin;
this.data = plugin.database; this.data = plugin.database;
} }
/**
* Method run.
*
* @see java.lang.Runnable#run()
*/
@Override @Override
public void run() { public void run() {
for (OfflinePlayer o : plugin.getServer().getOfflinePlayers()) { for (OfflinePlayer o : plugin.getServer().getOfflinePlayers()) {

View File

@ -4,35 +4,18 @@ import fr.xephi.authme.settings.CustomConfiguration;
import java.io.File; import java.io.File;
/** class RoyalAuthYamlReader extends CustomConfiguration {
*/
public class RoyalAuthYamlReader extends CustomConfiguration {
/**
* Constructor for RoyalAuthYamlReader.
*
* @param file File
*/
public RoyalAuthYamlReader(File file) { public RoyalAuthYamlReader(File file) {
super(file); super(file);
load(); load();
save(); save();
} }
/**
* Method getLastLogin.
*
* @return long
*/
public long getLastLogin() { public long getLastLogin() {
return getLong("timestamps.quit"); return getLong("timestamps.quit");
} }
/**
* Method getHash.
*
* @return String
*/
public String getHash() { public String getHash() {
return getString("login.password"); return getString("login.password");
} }

View File

@ -2,38 +2,22 @@ package fr.xephi.authme.converter;
import fr.xephi.authme.AuthMe; import fr.xephi.authme.AuthMe;
import fr.xephi.authme.ConsoleLogger; import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.datasource.DataSource;
import org.bukkit.command.CommandSender; import org.bukkit.command.CommandSender;
/**
*/
public class vAuthConverter implements Converter { public class vAuthConverter implements Converter {
public final AuthMe plugin; private final AuthMe plugin;
public final DataSource database; private final CommandSender sender;
public final CommandSender sender;
/**
* Constructor for vAuthConverter.
*
* @param plugin AuthMe
* @param sender CommandSender
*/
public vAuthConverter(AuthMe plugin, CommandSender sender) { public vAuthConverter(AuthMe plugin, CommandSender sender) {
this.plugin = plugin; this.plugin = plugin;
this.database = plugin.database;
this.sender = sender; this.sender = sender;
} }
/**
* Method run.
*
* @see java.lang.Runnable#run()
*/
@Override @Override
public void run() { public void run() {
try { try {
new vAuthFileReader(plugin, sender).convert(); new vAuthFileReader(plugin).convert();
} catch (Exception e) { } catch (Exception e) {
sender.sendMessage(e.getMessage()); sender.sendMessage(e.getMessage());
ConsoleLogger.showError(e.getMessage()); ConsoleLogger.showError(e.getMessage());

View File

@ -6,30 +6,24 @@ import fr.xephi.authme.cache.auth.PlayerAuth;
import fr.xephi.authme.datasource.DataSource; import fr.xephi.authme.datasource.DataSource;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.OfflinePlayer; import org.bukkit.OfflinePlayer;
import org.bukkit.command.CommandSender;
import java.io.File; import java.io.File;
import java.util.Scanner; import java.util.Scanner;
import java.util.UUID; import java.util.UUID;
/** class vAuthFileReader {
*/
public class vAuthFileReader {
public final AuthMe plugin; private final AuthMe plugin;
public final DataSource database; private final DataSource database;
public final CommandSender sender;
/** /**
* Constructor for vAuthFileReader. * Constructor for vAuthFileReader.
* *
* @param plugin AuthMe * @param plugin AuthMe
* @param sender CommandSender
*/ */
public vAuthFileReader(AuthMe plugin, CommandSender sender) { public vAuthFileReader(AuthMe plugin) {
this.plugin = plugin; this.plugin = plugin;
this.database = plugin.database; this.database = plugin.database;
this.sender = sender;
} }
public void convert() { public void convert() {
@ -68,13 +62,6 @@ public class vAuthFileReader {
return s.length() > 8 && s.charAt(8) == '-'; return s.length() > 8 && s.charAt(8) == '-';
} }
/**
* Method getName.
*
* @param uuid UUID
*
* @return String
*/
private String getName(UUID uuid) { private String getName(UUID uuid) {
try { try {
for (OfflinePlayer op : Bukkit.getOfflinePlayers()) { for (OfflinePlayer op : Bukkit.getOfflinePlayers()) {

View File

@ -5,8 +5,8 @@ import org.bukkit.command.CommandSender;
public class xAuthConverter implements Converter { public class xAuthConverter implements Converter {
public final AuthMe plugin; private final AuthMe plugin;
public final CommandSender sender; private final CommandSender sender;
public xAuthConverter(AuthMe plugin, CommandSender sender) { public xAuthConverter(AuthMe plugin, CommandSender sender) {
this.plugin = plugin; this.plugin = plugin;

View File

@ -16,11 +16,11 @@ import java.sql.SQLException;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
public class xAuthToFlat { class xAuthToFlat {
public final AuthMe instance; private final AuthMe instance;
public final DataSource database; private final DataSource database;
public final CommandSender sender; private final CommandSender sender;
/** /**
* Constructor for xAuthToFlat. * Constructor for xAuthToFlat.
@ -57,14 +57,14 @@ public class xAuthToFlat {
database.saveAuth(auth); database.saveAuth(auth);
} }
} }
sender.sendMessage("[AuthMe] Successfully convert from xAuth database"); sender.sendMessage("[AuthMe] Successfully converted from xAuth database");
} catch (Exception e) { } catch (Exception e) {
sender.sendMessage("[AuthMe] An error has been thrown while import xAuth database, the import hadn't fail but can be not complete "); sender.sendMessage("[AuthMe] An error has been thrown while import xAuth database, the import hadn't fail but can be not complete ");
} }
return true; return true;
} }
public String getIdPlayer(int id) { private String getIdPlayer(int id) {
String realPass = ""; String realPass = "";
Connection conn = xAuth.getPlugin().getDatabaseController().getConnection(); Connection conn = xAuth.getPlugin().getDatabaseController().getConnection();
PreparedStatement ps = null; PreparedStatement ps = null;
@ -86,7 +86,7 @@ public class xAuthToFlat {
return realPass; return realPass;
} }
public List<Integer> getXAuthPlayers() { private List<Integer> getXAuthPlayers() {
List<Integer> xP = new ArrayList<>(); List<Integer> xP = new ArrayList<>();
Connection conn = xAuth.getPlugin().getDatabaseController().getConnection(); Connection conn = xAuth.getPlugin().getDatabaseController().getConnection();
PreparedStatement ps = null; PreparedStatement ps = null;
@ -107,7 +107,7 @@ public class xAuthToFlat {
return xP; return xP;
} }
public String getPassword(int accountId) { private String getPassword(int accountId) {
String realPass = ""; String realPass = "";
Connection conn = xAuth.getPlugin().getDatabaseController().getConnection(); Connection conn = xAuth.getPlugin().getDatabaseController().getConnection();
PreparedStatement ps = null; PreparedStatement ps = null;