Mailing-List: contact notifications-help@accumulo.apache.org; run by ezmlm
Precedence: bulk
Reply-To: jira@apache.org
Date: Wed, 15 Apr 2015 14:56:59 +0000 (UTC)
From: "Keith Turner (JIRA)" <jira@apache.org>
To: notifications@accumulo.apache.org
Message-ID: <JIRA.12780981.1426019902000.8345.1429109819078@Atlassian.JIRA>
In-Reply-To: <JIRA.12780981.1426019902000@Atlassian.JIRA>
References: <JIRA.12780981.1426019902000@Atlassian.JIRA>
 <JIRA.12780981.1426019902088@arcas>
Subject: [jira] [Commented] (ACCUMULO-3657) API Specification is incomplete
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


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

Keith Turner commented on ACCUMULO-3657:
----------------------------------------

I was thinking about what the 1.6.3 API statement should be and it occurred to me that changing the API stmt would violate semver.  For example if {{data.PartialKey}} were added to the 1.6.3 API stmt it would conceptually add a type to the API in 1.6.3.   I am thinking about the 1.6 API stmt relative to the the proposed in 1.7 API stmt in the README PR this issue.

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