From 2c971eb9bce5a15c1a67e4c2f9fd81883ef543dd Mon Sep 17 00:00:00 2001
From: graywolf336 <graywolf336@craftyn.com>
Date: Thu, 12 Jun 2014 11:00:01 -0500
Subject: [PATCH] Add some JavaDoc explaining what the CacheListener is for.

---
 .../graywolf336/jail/listeners/CacheListener.java  | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/src/main/java/com/graywolf336/jail/listeners/CacheListener.java b/src/main/java/com/graywolf336/jail/listeners/CacheListener.java
index 75121b3..64f7e3e 100644
--- a/src/main/java/com/graywolf336/jail/listeners/CacheListener.java
+++ b/src/main/java/com/graywolf336/jail/listeners/CacheListener.java
@@ -16,6 +16,20 @@ import com.graywolf336.jail.events.PrisonerJailedEvent;
 import com.graywolf336.jail.events.PrisonerReleasedEvent;
 import com.graywolf336.jail.events.PrisonerTransferredEvent;
 
+/**
+ * The listen for all events which need to add/remove to the prisoner cache.
+ * 
+ * <p />
+ * 
+ * These listeners add and remove prisoner cache objects to the cache,
+ * this way we gain performance for servers which have a high amount
+ * of prisoners jailed. (500+)
+ * 
+ * @author graywolf336
+ * @since 3.0.0
+ * @version 1.0.0
+ *
+ */
 public class CacheListener implements Listener {
 	private JailMain pl;