[accumulo] branch main updated: Improve InstanceOperations Doc (#2247)

[do...@apache.org]

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

domgarguilo 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 87dac96  Improve InstanceOperations Doc (#2247)
87dac96 is described below

commit 87dac9634aeff03ddb93be44c74175059c635d01
Author: Dom G <47...@users.noreply.github.com>
AuthorDate: Wed Sep 22 13:55:12 2021 -0400

    Improve InstanceOperations Doc (#2247)
    
    * Improve instanceOperations doc
    
    Co-authored-by: Jeffrey Manno <je...@gmail.com>
---
 .../core/client/admin/InstanceOperations.java      | 24 +++++++++++-----------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java b/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java
index 0346eee..f4b6dbd 100644
--- a/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java
+++ b/core/src/main/java/org/apache/accumulo/core/client/admin/InstanceOperations.java
@@ -27,17 +27,17 @@ import org.apache.accumulo.core.client.AccumuloSecurityException;
 public interface InstanceOperations {
 
   /**
-   * Sets an system property in zookeeper. Tablet servers will pull this setting and override the
+   * Sets a system property in zookeeper. Tablet servers will pull this setting and override the
    * equivalent setting in accumulo.properties. Changes can be seen using
    * {@link #getSystemConfiguration()}.
    * <p>
    * Only some properties can be changed by this method, an IllegalArgumentException will be thrown
-   * if a read-only property is set.
+   * if there is an attempt to set a read-only property.
    *
    * @param property
-   *          the name of a per-table property
+   *          the name of a system property
    * @param value
-   *          the value to set a per-table property to
+   *          the value to set a system property to
    * @throws AccumuloException
    *           if a general error occurs
    * @throws AccumuloSecurityException
@@ -51,7 +51,7 @@ public interface InstanceOperations {
    * {@link #getSystemConfiguration()}
    *
    * @param property
-   *          the name of a per-table property
+   *          the name of a system property
    * @throws AccumuloException
    *           if a general error occurs
    * @throws AccumuloSecurityException
@@ -64,15 +64,15 @@ public interface InstanceOperations {
    *
    * @return A map of system properties set in zookeeper. If a property is not set in zookeeper,
    *         then it will return the value set in accumulo.properties on some server. If nothing is
-   *         set in an accumulo.properties file it will return the default value for each property.
+   *         set in an accumulo.properties file, the default value for each property will be used.
    */
   Map<String,String> getSystemConfiguration() throws AccumuloException, AccumuloSecurityException;
 
   /**
-   * Retrieve the site configuration (that set in the server configuration file).
+   * Retrieve the site configuration (that is set in the server configuration file).
    *
    * @return A map of system properties set in accumulo.properties on some server. If nothing is set
-   *         in an accumulo.properties file it will return the default value for each property.
+   *         in an accumulo.properties file, the default value for each property will be used.
    */
   Map<String,String> getSiteConfiguration() throws AccumuloException, AccumuloSecurityException;
 
@@ -92,10 +92,10 @@ public interface InstanceOperations {
   List<String> getTabletServers();
 
   /**
-   * List the active scans on tablet server.
+   * List the active scans on a tablet server.
    *
    * @param tserver
-   *          The tablet server address should be of the form {@code <ip address>:<port>}
+   *          The tablet server address. This should be of the form {@code <ip address>:<port>}
    * @return A list of active scans on tablet server.
    */
   List<ActiveScan> getActiveScans(String tserver)
@@ -108,7 +108,7 @@ public interface InstanceOperations {
    * of all compactions running on tservers and compactors.
    *
    * @param tserver
-   *          The tablet server address should be of the form {@code <ip address>:<port>}
+   *          The tablet server address. This should be of the form {@code <ip address>:<port>}
    * @return the list of active compactions
    * @since 1.5.0
    */
@@ -127,7 +127,7 @@ public interface InstanceOperations {
    * Throws an exception if a tablet server can not be contacted.
    *
    * @param tserver
-   *          The tablet server address should be of the form {@code <ip address>:<port>}
+   *          The tablet server address. This should be of the form {@code <ip address>:<port>}
    * @since 1.5.0
    */
   void ping(String tserver) throws AccumuloException;