Add some JavaDoc explaining what the CacheListener is for.

This commit is contained in:
graywolf336 2014-06-12 11:00:01 -05:00
parent c6cdd5499e
commit 2c971eb9bc

View File

@ -16,6 +16,20 @@ import com.graywolf336.jail.events.PrisonerJailedEvent;
import com.graywolf336.jail.events.PrisonerReleasedEvent; import com.graywolf336.jail.events.PrisonerReleasedEvent;
import com.graywolf336.jail.events.PrisonerTransferredEvent; 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 { public class CacheListener implements Listener {
private JailMain pl; private JailMain pl;