HBASE-22484 Javadoc Warnings: Fix warnings coming due to @Result tag in TestCoprocessorWhitelistMasterObserver (#256)

Author: murtazahassan123

hbase-server/src/test/java/org/apache/hadoop/hbase/security/access/TestCoprocessorWhitelistMasterObserver.java

@@ -87,14 +87,10 @@ public void tearDownTestCoprocessorWhitelistMasterObserver() throws Exception {
   }
 
   /**
-   * Test a table modification adding a coprocessor path
-   * which is not whitelisted
-   * @result An IOException should be thrown and caught
-   *         to show coprocessor is working as desired
-   * @param whitelistedPaths A String array of paths to add in
-   *         for the whitelisting configuration
-   * @param coprocessorPath A String to use as the
-   *         path for a mock coprocessor
+   * Test a table modification adding a coprocessor path which is not whitelisted.
+   * @exception Exception should be thrown and caught to show coprocessor is working as desired
+   * @param whitelistedPaths A String array of paths to add in for the whitelisting configuration
+   * @param coprocessorPath  A String to use as the path for a mock coprocessor
    */
   private static void positiveTestCase(String[] whitelistedPaths, String coprocessorPath)
     throws Exception {
@@ -128,14 +124,10 @@ private static void positiveTestCase(String[] whitelistedPaths, String coprocess
   }
 
   /**
-   * Test a table modification adding a coprocessor path
-   * which is whitelisted
-   * @result The coprocessor should be added to the table
-   *         descriptor successfully
-   * @param whitelistedPaths A String array of paths to add in
-   *         for the whitelisting configuration
-   * @param coprocessorPath A String to use as the
-   *         path for a mock coprocessor
+   * Test a table modification adding a coprocessor path which is whitelisted. The coprocessor
+   * should be added to the table descriptor successfully.
+   * @param whitelistedPaths A String array of paths to add in for the whitelisting configuration
+   * @param coprocessorPath  A String to use as the path for a mock coprocessor
    */
   private static void negativeTestCase(String[] whitelistedPaths, String coprocessorPath)
     throws Exception {
@@ -169,10 +161,8 @@ private static void negativeTestCase(String[] whitelistedPaths, String coprocess
   }
 
   /**
-   * Test a table modification adding a coprocessor path
-   * which is not whitelisted
-   * @result An IOException should be thrown and caught
-   *         to show coprocessor is working as desired
+   * Test a table modification adding a coprocessor path which is not whitelisted.
+   * @exception Exception should be thrown and caught to show coprocessor is working as desired
    */
   @Test
   public void testSubstringNonWhitelisted() throws Exception {
@@ -181,11 +171,9 @@ public void testSubstringNonWhitelisted() throws Exception {
   }
 
   /**
-   * Test a table creation including a coprocessor path
-   * which is not whitelisted
-   * @result Coprocessor should be added to table descriptor
-   *         Table is disabled to avoid an IOException due to
-   *         the added coprocessor not actually existing on disk
+   * Test a table creation including a coprocessor path which is not whitelisted. Coprocessor should
+   * be added to table descriptor. Table is disabled to avoid an IOException due to the added
+   * coprocessor not actually existing on disk.
    */
   @Test
   public void testDifferentFileSystemNonWhitelisted() throws Exception {
@@ -194,11 +182,9 @@ public void testDifferentFileSystemNonWhitelisted() throws Exception {
   }
 
   /**
-   * Test a table modification adding a coprocessor path
-   * which is whitelisted
-   * @result Coprocessor should be added to table descriptor
-   *         Table is disabled to avoid an IOException due to
-   *         the added coprocessor not actually existing on disk
+   * Test a table modification adding a coprocessor path which is whitelisted. Coprocessor should be
+   * added to table descriptor. Table is disabled to avoid an IOException due to the added
+   * coprocessor not actually existing on disk.
    */
   @Test
   public void testSchemeAndDirectorywhitelisted() throws Exception {
@@ -207,23 +193,19 @@ public void testSchemeAndDirectorywhitelisted() throws Exception {
   }
 
   /**
-   * Test a table modification adding a coprocessor path
-   * which is whitelisted
-   * @result Coprocessor should be added to table descriptor
-   *         Table is disabled to avoid an IOException due to
-   *         the added coprocessor not actually existing on disk
+   * Test a table modification adding a coprocessor path which is whitelisted. Coprocessor should be
+   * added to table descriptor. Table is disabled to avoid an IOException due to the added
+   * coprocessor not actually existing on disk.
    */
   @Test
   public void testSchemeWhitelisted() throws Exception {
     negativeTestCase(new String[] { "file:///" }, "file:///permitted/couldnotpossiblyexist.jar");
   }
 
   /**
-   * Test a table modification adding a coprocessor path
-   * which is whitelisted
-   * @result Coprocessor should be added to table descriptor
-   *         Table is disabled to avoid an IOException due to
-   *         the added coprocessor not actually existing on disk
+   * Test a table modification adding a coprocessor path which is whitelisted. Coprocessor should be
+   * added to table descriptor. Table is disabled to avoid an IOException due to the added
+   * coprocessor not actually existing on disk.
    */
   @Test
   public void testDFSNameWhitelistedWorks() throws Exception {
@@ -232,11 +214,9 @@ public void testDFSNameWhitelistedWorks() throws Exception {
   }
 
   /**
-   * Test a table modification adding a coprocessor path
-   * which is whitelisted
-   * @result Coprocessor should be added to table descriptor
-   *         Table is disabled to avoid an IOException due to
-   *         the added coprocessor not actually existing on disk
+   * Test a table modification adding a coprocessor path which is whitelisted. Coprocessor should be
+   * added to table descriptor. Table is disabled to avoid an IOException due to the added
+   * coprocessor not actually existing on disk.
    */
   @Test
   public void testDFSNameNotWhitelistedFails() throws Exception {
@@ -245,21 +225,18 @@ public void testDFSNameNotWhitelistedFails() throws Exception {
   }
 
   /**
-   * Test a table modification adding a coprocessor path
-   * which is whitelisted
-   * @result Coprocessor should be added to table descriptor
-   *         Table is disabled to avoid an IOException due to
-   *         the added coprocessor not actually existing on disk
+   * Test a table modification adding a coprocessor path which is whitelisted. Coprocessor should be
+   * added to table descriptor. Table is disabled to avoid an IOException due to the added
+   * coprocessor not actually existing on disk.
    */
   @Test
   public void testBlanketWhitelist() throws Exception {
     negativeTestCase(new String[] { "*" }, "hdfs:///permitted/couldnotpossiblyexist.jar");
   }
 
   /**
-   * Test a table creation including a coprocessor path
-   * which is not whitelisted
-   * @result Table will not be created due to the offending coprocessor
+   * Test a table creation including a coprocessor path which is not whitelisted. Table will not be
+   * created due to the offending coprocessor.
    */
   @Test
   public void testCreationNonWhitelistedCoprocessorPath() throws Exception {
@@ -303,9 +280,8 @@ public Optional<RegionObserver> getRegionObserver() {
   }
 
   /**
-   * Test a table creation including a coprocessor path
-   * which is on the classpath
-   * @result Table will be created with the coprocessor
+   * Test a table creation including a coprocessor path which is on the classpath. Table will be
+   * created with the coprocessor.
    */
   @Test
   public void testCreationClasspathCoprocessor() throws Exception {