[jira] [Comment Edited] (ACCUMULO-3657) API Specification is incomplete

["Josh Elser (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ACCUMULO-3657?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14490679#comment-14490679 ] 

Josh Elser edited comment on ACCUMULO-3657 at 4/11/15 1:10 AM:
---------------------------------------------------------------

bq. Would also like feedback on the types I proposed adding to the API definition. 

+1

Looking at the sample pom, though, I had a hard time understanding what I was actually reading. I guess the includes/excludes are regexs? Would the analyze goal be tied to any lifecycle phase? Would this feel like a findbugs/checkstyle?

bq. I excluded mock from the set of public API types. I feel mock is not being maintained and should be deprecated to communicate that to users

After working with HBase tests, I'm soundly convinced ACCUMULO-2739 is the way to go (if/when someone does the lifting) to create a faster minicluster.


was (Author: elserj):
bq. Would also like feedback on the types I proposed adding to the API definition. 

+1

Looking at the sample pom, though, I had a hard time understanding what I was actually reading. I guess the includes/excludes are regexs? Would the analyze goal be tied to any lifecycle phase? Would this feel like a findbugs/checkstyle?

bq. I excluded mock from the set of public API types. I feel mock is not being maintained and should be deprecated to communicate that to users

After working with HBase tests, I'm soundly convinced ACCUMULO-2735 is the way to go (if/when someone does the lifting) to create a faster minicluster.

> API Specification is incomplete
> -------------------------------
>
>                 Key: ACCUMULO-3657
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-3657
>             Project: Accumulo
>          Issue Type: Bug
>    Affects Versions: 1.5.0, 1.5.1, 1.5.2, 1.6.0, 1.6.1, 1.6.2
>            Reporter: Keith Turner
>            Assignee: Keith Turner
>            Priority: Blocker
>             Fix For: 1.5.3, 1.7.0, 1.6.3
>
>         Attachments: apilyzer-1.txt, pom-1.xml
>
>
> While working on [fluo-365|https://github.com/fluo-io/fluo/issues/365] and trying to create an [example Accumulo API checkstyle rule|https://gist.github.com/keith-turner/ee0deafe88fa9f5bc43f] I discovered that API specification in the README is incomplete.   The API specification does not include the following classes (which are referenced by classes that are declared to be in public API).
>  * o.a.a.core.security.ColumnVisibility (used by public methods in Mutation)
>  * o.a.a.core.security.Authorizations (used by public methods in Connector)
>  * o.a.a.core.data.ByteSequence (used by public methods in Key)
>  * o.a.a.core.data.PartialKey (used by public methods in Key)
>  * o.a.a.core.data.ColumnUpdate (used by public methods in Mutation)
> This list is not exhausitive, I did not analyze all methods in public API.  These are just the issue I ran into while trying to apply a checkstyle rule to Fluo.
> After correcting the README and website, it would be nice to add a recommended checkstyle rule to the web site.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)