This is an automated email from the ASF dual-hosted git repository. kturner pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/accumulo.git
The following commit(s) were added to refs/heads/master by this push: new 481f68e Link to API definition on website (#660) 481f68e is described below commit 481f68e456d1b9724601b219a8f4fc0003be6591 Author: Keith Turner <ke...@deenlo.com> AuthorDate: Tue Sep 25 14:07:13 2018 -0400 Link to API definition on website (#660) --- README.md | 8 +--- .../org/apache/accumulo/core/client/Accumulo.java | 44 ++-------------------- pom.xml | 1 - 3 files changed, 5 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index 2a59659..b4a3792 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ news and general information. * Follow [these instructions][install] to install and run Accumulo * Read the [Accumulo documentation][docs] * Run the [Accumulo examples][examples] to learn how to write Accumulo clients -* View the [Javadocs][javadocs] to learn the Accumulo API +* View the [Javadocs][javadocs] to learn the [Accumulo API][api] More resources can be found on the [project website][accumulo]. @@ -44,10 +44,6 @@ waiting for the tests to run. This command produces `assemble/target/accumulo-<version>-bin.tar.gz` -## Accumulo API - -The javadoc in [Accumulo.java] defines Accumulo's public API. - ## Export Control This distribution includes cryptographic software. The country in which you @@ -76,7 +72,7 @@ the bouncycastle library for some crypographic technology as well. See [the BouncyCastle FAQ][bouncy-faq] for more details on bouncycastle's cryptography features. -[Accumulo.java]: core/src/main/java/org/apache/accumulo/core/client/Accumulo.java +[api]: https://accumulo.apache.org/api [accumulo]: https://accumulo.apache.org [logo]: contrib/accumulo-logo.png [install]: INSTALL.md diff --git a/core/src/main/java/org/apache/accumulo/core/client/Accumulo.java b/core/src/main/java/org/apache/accumulo/core/client/Accumulo.java index cfaa7ac..645bd02 100644 --- a/core/src/main/java/org/apache/accumulo/core/client/Accumulo.java +++ b/core/src/main/java/org/apache/accumulo/core/client/Accumulo.java @@ -20,49 +20,10 @@ import org.apache.accumulo.core.client.impl.AccumuloClientImpl; import org.apache.accumulo.core.client.lexicoder.Lexicoder; import org.apache.accumulo.core.client.rfile.RFile; -//CHECKSTYLE:OFF /** - * Entry point for majority of Accumulo's public API. Other Accumulo API entry points are linked - * below. - * - * <H2>API Definition</H2> - * - * Accumulo's public API is composed of all public types in the following packages and their - * sub-packages excluding those named <i>impl</i>, <i>thrift</i>, or <i>crypto</i>. - * - * <UL> - * <LI>org.apache.accumulo.core.client - * <LI>org.apache.accumulo.core.data - * <LI>org.apache.accumulo.core.security - * <LI>org.apache.accumulo.minicluster - * </UL> - * - * <p> - * A type is a class, interface, or enum. Anything with public or protected access in an API type is - * in the API. This includes, but is not limited to: methods, members classes, interfaces, and - * enums. Package-private types in the above packages are <i>not</i> considered public API. - * - * <p> - * API changes are made according to semver 2.0. Accumulo did not always follow semver, it was - * adopted for Accumulo 1.6.2 and 1.7.0. The Accumulo project maintains binary compatibility across - * this API within a major release, as defined in the Java Language Specification 3rd ed. Accumulo - * code outside of the API does not follow semver and may change in incompatible ways at any - * release. - * - * <p> - * The following regex matches imports that are <i>not</i> Accumulo public API. This regex can be - * used with <a href="http://checkstyle.sourceforge.net/config_regexp.html">RegexpSingleline</a> to - * automatically find suspicious imports in a project using Accumulo. - * - * <p> - * {@code import\s+org\.apache\.accumulo\.(.*\.(impl|thrift|crypto)\..*|(?!core|minicluster).*|core\.(?!client|data|security).*)} - * - * <H2>API Entry Points</H2> - * - * <p> * This class contains all API entry points created in 2.0.0 or later. The majority of the API is - * accessible indirectly via methods in this class. Below are a list of APIs entry points that were - * created before Accumulo 2.0 and not accessible from here. + * accessible indirectly via methods in this class. Below are a list of APIs entry points that are + * not accessible from here. * * <UL> * <LI>Hadoop input, output formats and partitioners in @@ -76,6 +37,7 @@ import org.apache.accumulo.core.client.rfile.RFile; * </UL> * * @see <a href="http://accumulo.apache.org/">Accumulo Website</a> + * @see <a href="http://accumulo.apache.org/api">Accumulo Public API</a> * @see <a href="http://semver.org/spec/v2.0.0">Semver 2.0</a> * @since 2.0.0 */ diff --git a/pom.xml b/pom.xml index e04decb..f575d03 100644 --- a/pom.xml +++ b/pom.xml @@ -1145,7 +1145,6 @@ <property name="eachLine" value="true" /> </module> <module name="TreeWalker"> - <module name="SuppressionCommentFilter" /> <module name="OneTopLevelClass" /> <module name="RegexpSinglelineJava"> <property name="format" value="\s+$" />