From da6aafc6240b4ab4ac4a83a909a5025392484630 Mon Sep 17 00:00:00 2001 From: Notmoo Date: Tue, 1 Aug 2017 16:27:53 +0200 Subject: [PATCH] Module Server, interface IMessageHandler : Ajout javadoc --- .../server/controller/IMessageHandler.java | 22 ++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/Workspace/server/src/main/WEB-INF/classes/com/pqt/server/controller/IMessageHandler.java b/Workspace/server/src/main/WEB-INF/classes/com/pqt/server/controller/IMessageHandler.java index ce4cec02..37abc1ad 100644 --- a/Workspace/server/src/main/WEB-INF/classes/com/pqt/server/controller/IMessageHandler.java +++ b/Workspace/server/src/main/WEB-INF/classes/com/pqt/server/controller/IMessageHandler.java @@ -2,7 +2,27 @@ package com.pqt.server.controller; import com.pqt.core.entities.messages.Message; -//TODO écrire Javadoc +/** + * Cette interface définit le type général correspondant à un élément censé traiter les objets de la classe {@link Message} arrivant au serveur. + * + * @author Guillaume "Cess" Prost + */ public interface IMessageHandler { + /** + * Traite le message {@code message} passé en paramètre. Renvoie un message de réponse en tant que retour de méthode. + *

+ * Cette méthode doit toujours renvoyer un objet message autre que {@code null}. Un message de type + * {@link com.pqt.core.entities.messages.MessageType#ERROR_QUERY} ou de type + * {@link com.pqt.core.entities.messages.MessageType#REFUSED_QUERY} doit-être renvoyé si le message donné ne peut + * être pris en charge.
+ * Cela signifie aussi que cette méthode ne doit pas lever d'exception, et que ces dernières doivent être + * gérées en interne. + *

+ * Pour plus de détail sur les messages, leurs significations et les réponses attendues, voir la documentation du + * projet. + * @param message Objet de la classe {@link Message} à traiter. + * + * @return Objet de la classe {@link Message} correspondant à la réponse au paramètre {@code message}. + */ Message handleMessage(Message message); }