[ACCUMULO-2590] Update public API in readme to clarify what's included

• Type: Task
• Status: Resolved
• Priority: Blocker
• Resolution: Fixed
• Fix Version/s: 1.6.0
• Component/s: docs
• Assignee: Sean Busbey
• Reporter: Sean Busbey
• Created: 28/Mar/14 20:15
• Updated: 02/Apr/14 06:55
• Resolved: 02/Apr/14 06:34

Description

Due to confusion expressed on the mailing list, edit the README section on the public API to make unambiguous:

1. the list of packages included (e.g. "all packages under org.apache.accumulo.core.client, save those named 'impl'")
2. that public Classes and Interfaces in those packages are covered
3. that within said Classes and Interfaces, we include
   1. public and protected members
   2. public and protected methods
   3. public and protected constructors
   4. public and protected inner Classes and Interfaces

And that "compatibility" means binary compatibility as defined in the Java Language Spec v3, Chapter 13

Issue Links

• is related to: ACCUMULO-2589 Create new client API