Prepare the project for javadocs

This commit is contained in:
Gabriele C
2015-11-21 01:27:06 +01:00
parent adcd70b91d
commit 118c79401a
168 changed files with 4375 additions and 422 deletions
@@ -1,25 +1,45 @@
package fr.xephi.authme.cache.backup;
/**
*/
public class DataFileCache {
private String group;
private boolean operator;
private boolean flying;
/**
* Constructor for DataFileCache.
* @param group String
* @param operator boolean
* @param flying boolean
*/
public DataFileCache(String group, boolean operator, boolean flying) {
this.group = group;
this.operator = operator;
this.flying = flying;
}
/**
* Method getGroup.
* @return String
*/
public String getGroup() {
return group;
}
/**
* Method getOperator.
* @return boolean
*/
public boolean getOperator() {
return operator;
}
/**
* Method isFlying.
* @return boolean
*/
public boolean isFlying() {
return flying;
}
@@ -22,6 +22,8 @@ import fr.xephi.authme.ConsoleLogger;
import fr.xephi.authme.settings.Settings;
import fr.xephi.authme.util.Utils;
/**
*/
public class JsonCache {
private final Gson gson;
@@ -39,6 +41,11 @@ public class JsonCache {
.create();
}
/**
* Method createCache.
* @param player Player
* @param playerData DataFileCache
*/
public void createCache(Player player, DataFileCache playerData) {
if (player == null) {
return;
@@ -68,6 +75,11 @@ public class JsonCache {
}
}
/**
* Method readCache.
* @param player Player
* @return DataFileCache
*/
public DataFileCache readCache(Player player) {
String path;
try {
@@ -90,7 +102,16 @@ public class JsonCache {
}
}
/**
*/
private class PlayerDataSerializer implements JsonSerializer<DataFileCache> {
/**
* Method serialize.
* @param dataFileCache DataFileCache
* @param type Type
* @param jsonSerializationContext JsonSerializationContext
* @return JsonElement
*/
@Override
public JsonElement serialize(DataFileCache dataFileCache, Type type, JsonSerializationContext jsonSerializationContext) {
JsonObject jsonObject = new JsonObject();
@@ -102,7 +123,18 @@ public class JsonCache {
}
}
/**
*/
private static class PlayerDataDeserializer implements JsonDeserializer<DataFileCache> {
/**
* Method deserialize.
* @param jsonElement JsonElement
* @param type Type
* @param jsonDeserializationContext JsonDeserializationContext
* @return DataFileCache
* @throws JsonParseException
* @see com.google.gson.JsonDeserializer#deserialize(JsonElement, Type, JsonDeserializationContext)
*/
@Override
public DataFileCache deserialize(JsonElement jsonElement, Type type, JsonDeserializationContext jsonDeserializationContext) throws JsonParseException {
JsonObject jsonObject = jsonElement.getAsJsonObject();
@@ -128,6 +160,10 @@ public class JsonCache {
}
}
/**
* Method removeCache.
* @param player Player
*/
public void removeCache(Player player) {
String path;
try {
@@ -144,6 +180,11 @@ public class JsonCache {
}
}
/**
* Method doesCacheExist.
* @param player Player
* @return boolean
*/
public boolean doesCacheExist(Player player) {
String path;
try {