Repository: accumulo Updated Branches: refs/heads/1.6.0-SNAPSHOT a1814fc0d -> d896bf37d
ACCUMULO-2590 Updates our Public API declaration to be more explicit. Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/d896bf37 Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/d896bf37 Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/d896bf37 Branch: refs/heads/1.6.0-SNAPSHOT Commit: d896bf37d2dcf1834e32425b7364e6d5963e4c12 Parents: a1814fc Author: Sean Busbey <bus...@cloudera.com> Authored: Fri Mar 28 16:47:00 2014 -0500 Committer: Sean Busbey <bus...@cloudera.com> Committed: Tue Apr 1 23:32:20 2014 -0700 ---------------------------------------------------------------------- README | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/accumulo/blob/d896bf37/README ---------------------------------------------------------------------- diff --git a/README b/README index ee98d92..692c502 100644 --- a/README +++ b/README @@ -346,15 +346,25 @@ redirected to the log dir. ****************************************************************************** 9. API -The public accumulo API is composed of : - - * everything under org.apache.accumulo.core.client, excluding impl packages - * Key, Mutation, Value, Range, Condition, and ConditionalMutation in +The public Accumulo API is composed of : + + * All public classes and interfaces in the org.apache.accumulo.core.client + package, as as well as all of its subpackages excluding those named "impl". + * Key, Mutation, Value, Range, Condition, and ConditionalMutation in org.apache.accumulo.core.data. - * org.apache.accumulo.minicluster, excluding impl package - + * All public classes and interfaces in the org.apache.accumulo.minicluster + package, as well as all of its subpackages excluding those named "impl". + * Anything with public or protected acccess within any Class or Interface that + is in the public API. This includes, but is not limited to: methods, members + classes, interfaces, and enums. + +The Accumulo project maintains binary compatibility across this API within a major +release, as defined in the Java Language Specification 3rd ed. API changes should +only be made on major releases, with continued support of deprecated API elements +for at least one major revision. + To get started using accumulo review the example and the javadoc for the -packages and classes mentioned above. +packages and classes mentioned above. ****************************************************************************** 10. Performance Tuning
