accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Christopher Tubbs (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-3657) API Specification is incomplete
Date Fri, 20 Mar 2015 22:51:38 GMT

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

Christopher Tubbs commented on ACCUMULO-3657:
---------------------------------------------

I made it into a maven plugin here: https://github.com/revelc/apilyzer-maven-plugin

Needs work to make it generalized (not Accumulo-specific), configurable, and to improve the
output, but it's a start.

> 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
>
>
> 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)

Mime
View raw message