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 Wed, 15 Apr 2015 18:13:59 GMT

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

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

I'm not sure that it'd be a violation. This isn't so much adding new things to the API, as
better documenting what is already in the API. At the very worst, this means that there's
additional classes we've declared have not changed in incompatible ways from the previous
version (these classes covered by a more thorough API stmt would still need to conform to
semver rules when comparing with the previous version, after all). That worst case doesn't
really seem like a problem to me... it's just informing users that things are slightly more
stable than they might otherwise have thought they were.

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

Mime
View raw message