Add class headers and remove @author tags
This makes the PR compliant with with the Mineplex coding style. Class headers are used to describe the function of a class and git history will be used to determine the author of a class.
This commit is contained in:
parent
8b6b3db412
commit
57e9cd6e19
@ -1,10 +1,10 @@
|
|||||||
package mineplex.core.chatsnap;
|
package mineplex.core.chatsnap;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @author iKeirNez
|
* Holds all types of messages a player can receive from another player
|
||||||
*/
|
*/
|
||||||
public enum MessageType
|
public enum MessageType
|
||||||
{
|
{
|
||||||
CHAT,
|
CHAT,
|
||||||
PM;
|
PM
|
||||||
}
|
}
|
||||||
|
@ -15,7 +15,6 @@ import static com.google.common.base.Preconditions.checkNotNull;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents a message sent by a player.
|
* Represents a message sent by a player.
|
||||||
* @author iKeirNez
|
|
||||||
*/
|
*/
|
||||||
public class Snapshot implements Comparable<Snapshot>
|
public class Snapshot implements Comparable<Snapshot>
|
||||||
{
|
{
|
||||||
|
@ -12,7 +12,6 @@ import mineplex.core.chatsnap.publishing.SnapshotPublisher;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Handles temporary storage of {@link Snapshot} instances.
|
* Handles temporary storage of {@link Snapshot} instances.
|
||||||
* @author iKeirNez
|
|
||||||
*/
|
*/
|
||||||
public class SnapshotManager
|
public class SnapshotManager
|
||||||
{
|
{
|
||||||
|
@ -15,7 +15,7 @@ import mineplex.core.chatsnap.commands.ChatCacheCommand;
|
|||||||
import mineplex.core.message.PrivateMessageEvent;
|
import mineplex.core.message.PrivateMessageEvent;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @author iKeirNez
|
* Starter class for all snapshot related functions (ie capturing messages, retrieving snapshots).
|
||||||
*/
|
*/
|
||||||
public class SnapshotPlugin extends MiniPlugin
|
public class SnapshotPlugin extends MiniPlugin
|
||||||
{
|
{
|
||||||
|
@ -15,7 +15,6 @@ import mineplex.core.common.util.UtilPlayer;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Displays what chat messages we have cached for a player.
|
* Displays what chat messages we have cached for a player.
|
||||||
* @author iKeirNez
|
|
||||||
*/
|
*/
|
||||||
public class ChatCacheCommand extends CommandBase<SnapshotPlugin>
|
public class ChatCacheCommand extends CommandBase<SnapshotPlugin>
|
||||||
{
|
{
|
||||||
|
@ -12,7 +12,7 @@ import com.google.gson.JsonSerializationContext;
|
|||||||
import com.google.gson.JsonSerializer;
|
import com.google.gson.JsonSerializer;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @author iKeirNez
|
* Handles serialization of Java 8's {@link LocalDateTime}.
|
||||||
*/
|
*/
|
||||||
public class LocalDateTimeSerializer implements JsonSerializer<LocalDateTime>
|
public class LocalDateTimeSerializer implements JsonSerializer<LocalDateTime>
|
||||||
{
|
{
|
||||||
|
@ -9,7 +9,7 @@ import com.google.gson.JsonSerializer;
|
|||||||
import mineplex.core.report.Report;
|
import mineplex.core.report.Report;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @author iKeirNez
|
* Handles serialization of {@link Report} instances.
|
||||||
*/
|
*/
|
||||||
public class ReportSerializer implements JsonSerializer<Report>
|
public class ReportSerializer implements JsonSerializer<Report>
|
||||||
{
|
{
|
||||||
|
@ -24,7 +24,7 @@ import redis.clients.jedis.Jedis;
|
|||||||
import redis.clients.jedis.JedisPool;
|
import redis.clients.jedis.JedisPool;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @author iKeirNez
|
* Class responsible for publishing snapshots on the website via Redis and a separate Report server.
|
||||||
*/
|
*/
|
||||||
public class SnapshotPublisher
|
public class SnapshotPublisher
|
||||||
{
|
{
|
||||||
|
@ -9,7 +9,6 @@ import mineplex.core.common.util.C;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Contains the reasons a player can be reported for.
|
* Contains the reasons a player can be reported for.
|
||||||
* @author iKeirNez
|
|
||||||
*/
|
*/
|
||||||
public enum ReportCategory
|
public enum ReportCategory
|
||||||
{
|
{
|
||||||
|
@ -5,7 +5,6 @@ import mineplex.core.report.Report;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* A message regarding a report which is sent only to the player handling the report.
|
* A message regarding a report which is sent only to the player handling the report.
|
||||||
* @author iKeirNez
|
|
||||||
*/
|
*/
|
||||||
public class ReportHandlerNotification extends ReportNotification
|
public class ReportHandlerNotification extends ReportNotification
|
||||||
{
|
{
|
||||||
|
@ -14,7 +14,6 @@ import mineplex.serverdata.commands.ServerCommand;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Handles receiving of report notifications.
|
* Handles receiving of report notifications.
|
||||||
* @author iKeirNez
|
|
||||||
*/
|
*/
|
||||||
public class ReportNotificationCallback implements CommandCallback
|
public class ReportNotificationCallback implements CommandCallback
|
||||||
{
|
{
|
||||||
|
@ -17,7 +17,6 @@ import org.apache.commons.lang3.StringUtils;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Displays a message containing up-to-date details of a report to it's handler.
|
* Displays a message containing up-to-date details of a report to it's handler.
|
||||||
* @author iKeirNez
|
|
||||||
*/
|
*/
|
||||||
public class ReportHandlerMessageTask extends BukkitRunnable
|
public class ReportHandlerMessageTask extends BukkitRunnable
|
||||||
{
|
{
|
||||||
|
@ -8,7 +8,6 @@ import mineplex.core.report.ReportManager;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Checks reports "owned" by this instance for inactivity, purges inactive reports.
|
* Checks reports "owned" by this instance for inactivity, purges inactive reports.
|
||||||
* @author iKeirNez
|
|
||||||
*/
|
*/
|
||||||
public class ReportPurgeTask extends BukkitRunnable
|
public class ReportPurgeTask extends BukkitRunnable
|
||||||
{
|
{
|
||||||
|
@ -8,7 +8,6 @@ import mineplex.core.report.ReportCategory;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents a clickable button in a {@link ReportCategoryPage} which determines the type of infraction a player has committed.
|
* Represents a clickable button in a {@link ReportCategoryPage} which determines the type of infraction a player has committed.
|
||||||
* @author iKeirNez
|
|
||||||
*/
|
*/
|
||||||
public class ReportCategoryButton extends SimpleGuiItem
|
public class ReportCategoryButton extends SimpleGuiItem
|
||||||
{
|
{
|
||||||
|
@ -15,7 +15,6 @@ import mineplex.core.report.ReportPlugin;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* User interface shown to a player when reporting another player.
|
* User interface shown to a player when reporting another player.
|
||||||
* @author iKeirNez
|
|
||||||
*/
|
*/
|
||||||
public class ReportCategoryPage extends SimpleGui
|
public class ReportCategoryPage extends SimpleGui
|
||||||
{
|
{
|
||||||
|
@ -11,7 +11,6 @@ import mineplex.core.report.ReportResult;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents a button which can be clicked to determine the result of a report.
|
* Represents a button which can be clicked to determine the result of a report.
|
||||||
* @author iKeirNez
|
|
||||||
*/
|
*/
|
||||||
public class ReportResultButton extends SimpleGuiItem
|
public class ReportResultButton extends SimpleGuiItem
|
||||||
{
|
{
|
||||||
|
@ -15,7 +15,6 @@ import mineplex.core.report.ReportResult;
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* User interface shown to a moderator when closing a report to determine the result of the report.
|
* User interface shown to a moderator when closing a report to determine the result of the report.
|
||||||
* @author iKeirNez
|
|
||||||
*/
|
*/
|
||||||
public class ReportResultPage extends SimpleGui
|
public class ReportResultPage extends SimpleGui
|
||||||
{
|
{
|
||||||
|
@ -8,7 +8,7 @@ import java.util.logging.Logger;
|
|||||||
import org.apache.commons.lang3.Validate;
|
import org.apache.commons.lang3.Validate;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @author iKeirNez
|
* Class responsible for deleting old files (file age is determined by the "last modified" value).
|
||||||
*/
|
*/
|
||||||
public class FilePurger implements Runnable
|
public class FilePurger implements Runnable
|
||||||
{
|
{
|
||||||
|
@ -20,7 +20,7 @@ import org.apache.commons.lang3.Validate;
|
|||||||
import redis.clients.jedis.JedisPubSub;
|
import redis.clients.jedis.JedisPubSub;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @author iKeirNez
|
* Listens for commands from Redis (such as "deploy" or "destroy") and executes them.
|
||||||
*/
|
*/
|
||||||
public class RedisCommandHandler extends JedisPubSub
|
public class RedisCommandHandler extends JedisPubSub
|
||||||
{
|
{
|
||||||
|
@ -9,7 +9,7 @@ import redis.clients.jedis.Jedis;
|
|||||||
import redis.clients.jedis.JedisPool;
|
import redis.clients.jedis.JedisPool;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @author iKeirNez
|
* Establishes and maintains a connection to Redis.
|
||||||
*/
|
*/
|
||||||
public class RedisConnectionHandler implements Runnable
|
public class RedisConnectionHandler implements Runnable
|
||||||
{
|
{
|
||||||
|
@ -21,7 +21,7 @@ import org.apache.commons.lang3.Validate;
|
|||||||
import redis.clients.jedis.JedisPool;
|
import redis.clients.jedis.JedisPool;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @author iKeirNez
|
* Main class for the Report server, parses command line arguments and initializes the Report server.
|
||||||
*/
|
*/
|
||||||
public class ReportServer
|
public class ReportServer
|
||||||
{
|
{
|
||||||
|
Loading…
Reference in New Issue
Block a user