You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by ct...@apache.org on 2022/09/15 15:50:13 UTC

[accumulo] branch main updated: Fix deprecation warning in javadoc

This is an automated email from the ASF dual-hosted git repository.

ctubbsii pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/accumulo.git


The following commit(s) were added to refs/heads/main by this push:
     new 87402dfcd8 Fix deprecation warning in javadoc
87402dfcd8 is described below

commit 87402dfcd8d828850ca2e4b01e8811cf506e7d4e
Author: Christopher Tubbs <ct...@apache.org>
AuthorDate: Thu Sep 15 11:36:46 2022 -0400

    Fix deprecation warning in javadoc
    
    As a follow up to #2921, remove link to deprecated method, and replace
    with inline code style, to avoid warning about linking to deprecated API
    methods in the javadoc.
    
    Also standardize HTML tags to use lowercase HTML5 tag names, as per
    HTML5 conventions and W3C recommendations.
---
 .../core/client/admin/TableOperations.java         | 20 ++++++++++----------
 .../accumulo/core/metadata/schema/Ample.java       | 14 +++++++-------
 .../core/spi/scan/SimpleScanDispatcher.java        | 22 +++++++++++-----------
 .../accumulo/tserver/tablet/CompactableImpl.java   | 14 +++++++-------
 4 files changed, 35 insertions(+), 35 deletions(-)

diff --git a/core/src/main/java/org/apache/accumulo/core/client/admin/TableOperations.java b/core/src/main/java/org/apache/accumulo/core/client/admin/TableOperations.java
index da6ed9d050..d956f442e2 100644
--- a/core/src/main/java/org/apache/accumulo/core/client/admin/TableOperations.java
+++ b/core/src/main/java/org/apache/accumulo/core/client/admin/TableOperations.java
@@ -434,16 +434,16 @@ public interface TableOperations {
    * <p>
    * The following optional settings can only be set by one compact call per table at the same time.
    *
-   * <UL>
-   * <LI>Execution hints : {@link CompactionConfig#setExecutionHints(Map)}</LI>
-   * <LI>Selector : {@link CompactionConfig#setSelector(PluginConfig)}</LI>
-   * <LI>Confgigurer : {@link CompactionConfig#setConfigurer(PluginConfig)}</LI>
-   * <LI>Iterators : {@link CompactionConfig#setIterators(List)}</LI>
-   * <LI>Compaction strategy :
-   * {@link CompactionConfig#setCompactionStrategy(CompactionStrategyConfig)}</LI>
-   * </UL>
-   *
-   * <P>
+   * <ul>
+   * <li>Execution hints : {@link CompactionConfig#setExecutionHints(Map)}</li>
+   * <li>Selector : {@link CompactionConfig#setSelector(PluginConfig)}</li>
+   * <li>Configurer : {@link CompactionConfig#setConfigurer(PluginConfig)}</li>
+   * <li>Iterators : {@link CompactionConfig#setIterators(List)}</li>
+   * <li>Compaction strategy (deprecated) :
+   * {@code CompactionConfig.setCompactionStrategy(CompactionStrategyConfig)}</li>
+   * </ul>
+   *
+   * <p>
    * If two threads call this method concurrently for the same table and set one or more of the
    * above then one thread will fail.
    *
diff --git a/core/src/main/java/org/apache/accumulo/core/metadata/schema/Ample.java b/core/src/main/java/org/apache/accumulo/core/metadata/schema/Ample.java
index 1ede902788..9921cb7072 100644
--- a/core/src/main/java/org/apache/accumulo/core/metadata/schema/Ample.java
+++ b/core/src/main/java/org/apache/accumulo/core/metadata/schema/Ample.java
@@ -47,21 +47,21 @@ import org.apache.hadoop.io.Text;
  * <p>
  * This interface seeks to satisfy the following goals.
  *
- * <UL>
- * <LI>Provide a single entry point for all reading and writing of Accumulo Metadata.
- * <LI>The root tablet persists its data in Zookeeper. Metadata tablets persist their data in root
+ * <ul>
+ * <li>Provide a single entry point for all reading and writing of Accumulo Metadata.
+ * <li>The root tablet persists its data in Zookeeper. Metadata tablets persist their data in root
  * tablet. All other tablets persist their data in the metadata table. This interface abstracts how
  * and where information for a tablet is actually persisted.
- * <LI>Before the creation of this interface, many concurrent metadata table updates resulted in
+ * <li>Before the creation of this interface, many concurrent metadata table updates resulted in
  * separate synchronous RPCs. The design of this interface allows batching of metadata table updates
  * within a tablet server for cluster wide efficiencies. Batching is not required by
  * implementations, but the design of the interface makes it possible.
- * <LI>Make code that updates Accumulo persistent metadata more concise. Before this interface
+ * <li>Make code that updates Accumulo persistent metadata more concise. Before this interface
  * existed, there was a lot of redundant and verbose code for updating metadata.
- * <LI>Reduce specialized code for the root tablet. Currently there is specialized code to manage
+ * <li>Reduce specialized code for the root tablet. Currently there is specialized code to manage
  * the root tablets files that is different from all other tablets. This interface is the beginning
  * of an effort to remove this specialized code. See #936
- * </UL>
+ * </ul>
  */
 public interface Ample {
 
diff --git a/core/src/main/java/org/apache/accumulo/core/spi/scan/SimpleScanDispatcher.java b/core/src/main/java/org/apache/accumulo/core/spi/scan/SimpleScanDispatcher.java
index 0fa6a645e2..4d2f4880e8 100644
--- a/core/src/main/java/org/apache/accumulo/core/spi/scan/SimpleScanDispatcher.java
+++ b/core/src/main/java/org/apache/accumulo/core/spi/scan/SimpleScanDispatcher.java
@@ -37,19 +37,19 @@ import org.apache.accumulo.core.spi.scan.ScanDispatch.CacheUsage;
  * {@link CacheUsage#TABLE} for index and data cache. This dispatcher supports the following
  * options.
  *
- * <UL>
- * <LI>{@code table.scan.dispatcher.opts.executor=<scan executor name>} : dispatches all scans to
- * the named executor.</LI>
- * <LI>{@code table.scan.dispatcher.opts.multi_executor=<scan executor name>} : dispatches batch
- * scans to the named executor.</LI>
- * <LI>{@code table.scan.dispatcher.opts.single_executor=<scan executor name>} : dispatches regular
- * scans to the named executor.</LI>
- * <LI>{@code table.scan.dispatcher.opts.executor.<type>=<scan executor name>} : dispatches scans
+ * <ul>
+ * <li>{@code table.scan.dispatcher.opts.executor=<scan executor name>} : dispatches all scans to
+ * the named executor.</li>
+ * <li>{@code table.scan.dispatcher.opts.multi_executor=<scan executor name>} : dispatches batch
+ * scans to the named executor.</li>
+ * <li>{@code table.scan.dispatcher.opts.single_executor=<scan executor name>} : dispatches regular
+ * scans to the named executor.</li>
+ * <li>{@code table.scan.dispatcher.opts.executor.<type>=<scan executor name>} : dispatches scans
  * that set the hint {@code scan_type=<type>} to the named executor. If this setting matches then it
- * takes precedence over all other settings. See {@link ScannerBase#setExecutionHints(Map)}</LI>
- * <LI>{@code table.scan.dispatcher.opts.cacheUsage.<type>[.index|.data]=enabled|disabled|opportunistic|table}
+ * takes precedence over all other settings. See {@link ScannerBase#setExecutionHints(Map)}</li>
+ * <li>{@code table.scan.dispatcher.opts.cacheUsage.<type>[.index|.data]=enabled|disabled|opportunistic|table}
  * : for scans that set the hint {@code scan_type=<type>} determines how the scan will use cache.
- * </UL>
+ * </ul>
  *
  * The {@code multi_executor} and {@code single_executor} options override the {@code executor}
  * option.
diff --git a/server/tserver/src/main/java/org/apache/accumulo/tserver/tablet/CompactableImpl.java b/server/tserver/src/main/java/org/apache/accumulo/tserver/tablet/CompactableImpl.java
index 8345a85052..e7ec5856ab 100644
--- a/server/tserver/src/main/java/org/apache/accumulo/tserver/tablet/CompactableImpl.java
+++ b/server/tserver/src/main/java/org/apache/accumulo/tserver/tablet/CompactableImpl.java
@@ -164,13 +164,13 @@ public class CompactableImpl implements Compactable {
    * This class tracks status of a tablets files for compactions for {@link CompactableImpl} owning
    * the following functionality.
    *
-   * <UL>
-   * <LI>Tracks which files are reserved for compactions
-   * <LI>Determines which files are available for compactions
-   * <LI>Tracks which files are chopped and which need to be chopped
-   * <LI>Tracks which files are selected for user and selector compactions
-   * <LI>Coordinates the file selection process
-   * </UL>
+   * <ul>
+   * <li>Tracks which files are reserved for compactions
+   * <li>Determines which files are available for compactions
+   * <li>Tracks which files are chopped and which need to be chopped
+   * <li>Tracks which files are selected for user and selector compactions
+   * <li>Coordinates the file selection process
+   * </ul>
    *
    * <p>
    * The class is structured in such a way that the above functionality can be unit tested.