Browse Source

doc: cache reloader

Martin Passard 7 years ago
parent
commit
4350b49c98
1 changed files with 17 additions and 0 deletions
  1. 17 0
      src/main/CacheReloader.java

+ 17 - 0
src/main/CacheReloader.java

@@ -3,16 +3,30 @@ package main;
 import java.util.Date;
 
 public class CacheReloader implements Runnable {
+	/**
+	 * Le but de cette classe est de permettre la mise à jour régulière du cache.
+	 * Pour cela, cette classe implémente est de type runnable, c'est à dire qu'elle possède une méthode pour creer un Thread qui vient ensuite se charger de la Mise à Jour.
+	 * Une fois une instance créée, elle se lance par start()
+	 * 
+	 */
 		private Thread thread;
 		private String threadName;
 		private long timeout;
 		boolean end = false;
+		
+	/**
+	 * Contructeur de la classe
+	 * @param timeout Temps à attendre entre chaque mise à jour
+	 */
 
 	public CacheReloader(long timeout) {
 		this.threadName="Cache reloader";
 		this.timeout=timeout;
 	}
 
+	/**
+	 * Met à jour le cache. Méthode appelée lors de la création du thread sur une instance de cette classe.
+	 */
 	@Override
 	public void run() {
 		try {
@@ -34,6 +48,9 @@ public class CacheReloader implements Runnable {
 
 	}
 	
+	/**
+	 * Methode pour lancer le cache reloader
+	 */
 	
 	public void start() {
 		System.out.println("Démarage du cache Reloader. Mise à jour toute les "+timeout+" secondes.");