updated API description

jeeutil/src/main/java/de/muehlencord/shared/jeeutil/FacesUtil.java

@@ -20,6 +20,7 @@ import javax.faces.application.FacesMessage;
 import javax.faces.context.FacesContext;
 
 /**
+ * Helper class for java faces application.
  *
  * @author Joern Muehlencord (joern@muehlencord.de)
  */
@@ -29,17 +30,32 @@ public abstract class FacesUtil {
         // hide constructor of abstract class
     }
 
+    /**
+     * returns true, if the current request is in the request phase. False
+     * otherwise.
+     *
+     * @return true, if the current request is in the request phase. False
+     * otherwise.
+     */
     public static boolean isRenderRequest() {
         return !FacesContext.getCurrentInstance().getRenderResponse();
     }
 
+    /**
+     * returns true, if the current request is in the response phase. True
+     * otherwise.
+     *
+     * @return true, if the current request is in the response phase. True
+     * otherwise.
+     */
     public static boolean isRenderResponse() {
         return FacesContext.getCurrentInstance().getRenderResponse();
     }
 
     /**
+     * Adds the given message to the "messages" object
      *
-     * @param message
+     * @param message the message to display
      * @deprecated use addMessage(clientId, message) or
      * addGlobalMessage(message) instead
      */
@@ -48,57 +64,114 @@ public abstract class FacesUtil {
         FacesContext.getCurrentInstance().addMessage("messages", message);
     }
 
+    /**
+     * Adds the given message to the object with the id specified by clientId.
+     *
+     * @param clientId the id of the object to bind the message to.
+     * @param message the message to display
+     */
     public static void addMessage(String clientId, FacesMessage message) {
         FacesContext.getCurrentInstance().addMessage(clientId, message);
     }
 
+    /**
+     * Adds the given message as global message.
+     *
+     * @param message the message to display
+     */
     public static void addGlobalMessage(FacesMessage message) {
         FacesContext.getCurrentInstance().addMessage(null, message);
     }
 
+    /**
+     * Adds the given message as global message with severity "Information".
+     *
+     * @param summary the message to add
+     */
     public static void addGlobalInfoMessage(String summary) {
         FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_INFO, summary, null);
         FacesContext.getCurrentInstance().addMessage(null, message);
     }
 
+    /**
+     * Adds the given message as global message with severity "Information".
+     *
+     * @param summary the summary message to display
+     * @param detail the detailed message to display
+     */
     public static void addGlobalInfoMessage(String summary, String detail) {
         FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_INFO, summary, detail);
         FacesContext.getCurrentInstance().addMessage(null, message);
     }
 
+    /**
+     * Adds the given message as global message with severity "Warning".
+     *
+     * @param summary the summary message to display
+     */
     public static void addGlobalWarningMessage(String summary) {
         FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_WARN, summary, null);
         FacesContext.getCurrentInstance().addMessage(null, message);
     }
 
+    /**
+     * Adds the given message as global message with severity "Warning".
+     *
+     * @param summary the summary message to display
+     * @param detail the detailed message to display
+     */
     public static void addGlobalWarningMessage(String summary, String detail) {
         FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_WARN, summary, detail);
         FacesContext.getCurrentInstance().addMessage(null, message);
     }
 
+    /**
+     * Adds the given message as global message with severity "Error".
+     *
+     * @param summary the message to display
+     */
     public static void addGlobalErrorMessage(String summary) {
         FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_ERROR, summary, null);
         FacesContext.getCurrentInstance().addMessage(null, message);
     }
 
+    /**
+     * Adds the given message as global message with severity "Error".
+     *
+     * @param summary the summary message to display
+     * @param detail the detailed message to display
+     */
     public static void addGlobalErrorMessage(String summary, String detail) {
         FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_ERROR, summary, detail);
         FacesContext.getCurrentInstance().addMessage(null, message);
     }
 
+    /**
+     * Adds the given message as global message with severity "Fatal".
+     *
+     * @param summary the message to display
+     */
     public static void addGlobalFatalMessage(String summary) {
         FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_FATAL, summary, null);
         FacesContext.getCurrentInstance().addMessage(null, message);
     }
 
+    /**
+     * Adds the given message as global message with severity "Fatal".
+     *
+     * @param summary the summary message to display
+     * @param detail the detailed message to display
+     */
     public static void addGlobalFatalMessage(String summary, String detail) {
         FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_FATAL, summary, detail);
         FacesContext.getCurrentInstance().addMessage(null, message);
     }
 
     /**
+     * Adds the given message to the object with id "messages" and severity
+     * "Information".
      *
-     * @param summary
+     * @param summary the message to display
      * @deprecated use addInfoMessage(clientId, summary) or addGlobalInfoMessage
      * instead
      */
@@ -108,9 +181,11 @@ public abstract class FacesUtil {
     }
 
     /**
+     * Adds the given message to the object with id "messages" and severity
+     * "Information".
      *
-     * @param summary
-     * @param detail
+     * @param summary the summary message to display
+     * @param detail the detailed message to display
      * @deprecated use addInfoMessage (clientId, summary, detail) or
      * addGlobalInfoMessage(summary, detail) instead
      */
@@ -119,14 +194,24 @@ public abstract class FacesUtil {
         addInfoMessage("messages", summary, detail);
     }
 
+    /**
+     * Adds the given message with severity "Info" to the object with the id
+     * specified by clientId.
+     *
+     * @param clientId the id of the object to bind the message to.
+     * @param summary the summary message to display
+     * @param detail the detailed message to display
+     */
     public static void addInfoMessage(String clientId, String summary, String detail) {
         FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_INFO, summary, detail);
         FacesContext.getCurrentInstance().addMessage(clientId, message);
     }
 
     /**
+     * Adds the given message to the object with id "warnings" and severity
+     * "Error".
      *
-     * @param summary
+     * @param summary the message to display
      * @deprecated use addErrorMessage (clientId, summary, detail) or
      * addGlobalErrorMessage(summary, detail) instead
      */
@@ -136,9 +221,12 @@ public abstract class FacesUtil {
     }
 
     /**
+     * Adds the given message to the object with id "warnings" and severity
+     * "Error".
      *
-     * @param summary
-     * @param detail
+     *
+     * @param summary the summary message to display
+     * @param detail the detailed message to display
      * @deprecated use addErrorMessage (clientId, summary, detail) or
      * addGlobalErrorMessage(summary, detail) instead
      */
@@ -147,14 +235,24 @@ public abstract class FacesUtil {
         addErrorMessage("warnings", summary, detail);
     }
 
+    /**
+     * Adds the given message with severity "Error" to the object with the id
+     * specified by clientId.
+     *
+     * @param clientId the id of the object to bind the message to.
+     * @param summary the summary message to display
+     * @param detail the detailed message to display
+     */
     public static void addErrorMessage(String clientId, String summary, String detail) {
         FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_ERROR, summary, detail);
         FacesContext.getCurrentInstance().addMessage(clientId, message);
     }
 
     /**
+     * Adds the given message to the object with id "warnings" and severity
+     * "Warning".
      *
-     * @param summary
+     * @param summary the message to display
      * @deprecated use addWarningMessage (clientId, summary, detail) or
      * addGlobalWarningMessage(summary, detail) instead
      */
@@ -164,9 +262,11 @@ public abstract class FacesUtil {
     }
 
     /**
+     * Adds the given message to the object with id "warnings" and severity
+     * "Warning".
      *
-     * @param summary
-     * @param detail
+     * @param summary the summary message to display
+     * @param detail the detailed message to display
      * @deprecated use addWarningMessage (clientId, summary, detail) or
      * addGlobalWarningMessage(summary, detail) instead
      */
@@ -176,15 +276,25 @@ public abstract class FacesUtil {
         FacesContext.getCurrentInstance().addMessage("warnings", message);
     }
 
+    /**
+     * Adds the given message with severity "Warning" to the object with the id
+     * specified by clientId.
+     *
+     * @param clientId the id of the object to bind the message to.
+     * @param summary the summary message to display
+     * @param detail the detailed message to display
+     */
     public static void addWarningMessage(String clientId, String summary, String detail) {
         FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_WARN, summary, detail);
         FacesContext.getCurrentInstance().addMessage(clientId, message);
     }
 
     /**
+     * Adds the given message to the object with id "warnings" and severity
+     * "Fatal".
      *
-     * @param summary
-     * @param detail
+     * @param summary the summary message to display
+     * @param detail the detailed message to display
      * @deprecated use addFatalMessage (clientId, summary, detail) or
      * addGlobalFatalMessage(summary, detail) instead
      */
@@ -194,11 +304,23 @@ public abstract class FacesUtil {
         FacesContext.getCurrentInstance().addMessage("warnings", message);
     }
 
+    /**
+     * Adds the given message with severity "Fatal" to the object with the id
+     * specified by clientId.
+     *
+     * @param clientId the id of the object to bind the message to.
+     * @param summary the summary message to display
+     * @param detail the detailed message to display
+     */
     public static void addFatalMessage(String clientId, String summary, String detail) {
         FacesMessage message = new FacesMessage(FacesMessage.SEVERITY_FATAL, summary, detail);
         FacesContext.getCurrentInstance().addMessage(clientId, message);
     }
 
+    /**
+     *
+     * @param messages the messages to add
+     */
     public static void addMessages(List<UIMessage> messages) {
         messages.stream().map(msg -> msg.getFacesMessage()).forEach(msg -> {
             if (msg.getSeverity() == FacesMessage.SEVERITY_ERROR) {
@@ -212,5 +334,5 @@ public abstract class FacesUtil {
             }
         });
     }
-    
+
 }