Bug 57143 - Javadocs and throws clause for WorkbookUtil

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1634412 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/poi/ss/util/WorkbookUtil.java b/src/java/org/apache/poi/ss/util/WorkbookUtil.java
index 71ad99e691e1d39963f2bc29b6cff4528be67f64..684434823cedfcca03e24b41d74ab8d5d5544d1a 100644 (file)
--- a/src/java/org/apache/poi/ss/util/WorkbookUtil.java
+++ b/src/java/org/apache/poi/ss/util/WorkbookUtil.java
@@ -124,6 +124,7 @@ public class WorkbookUtil {
      * </p>
      *
      * @param sheetName the name to validate
+     * @throws IllegalArgumentException if validation fails
      */
     public static void validateSheetName(String sheetName) {
         if (sheetName == null) {
@@ -160,6 +161,15 @@ public class WorkbookUtil {
     }
 
 
+    /**
+     * Validates sheet state
+     *
+     * @param state the state to validate
+     * @throws IllegalArgumentException if state is not one of
+     *      {@link Workbook#SHEET_STATE_VISIBLE},
+     *      {@link Workbook#SHEET_STATE_HIDDEN} or
+     *      {@link Workbook#SHEET_STATE_VERY_HIDDEN}
+     */
     public static void validateSheetState(int state) {
         switch(state){
             case Workbook.SHEET_STATE_VISIBLE: break;