[
https://issues.apache.org/jira/browse/HADOOP-6775?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12869814#action_12869814
]
Sanjay Radia commented on HADOOP-6775:
--------------------------------------
I was planning to add the following item to the FAQ section. Would this address
your comment?
<add to FAQ section>
How does the classification relate to the Java's visibility declaration?
Java allows public, private and protected declarations.
• A java-private element is always audience-private.
• An audience-public element is always java-public; the reverse is not
always true. One is often forced to make an API java-public to allow related
packages to access the API. Such java-public APIs may be classified as
audience-limited-private or even audience-private.
• A java-protected element may be audience-private (for internal
sub-classing within an implementation), or audience-public if it is intended
for general use (as with HDFS's AbstractFileSystem class).
• If JSR-294 completes (currently inactive) it will likely help in
aligning our classification with the Java visibility rules: it appears that one
of the goals of the JSR-294 is to better deal with visibility across
peer-packages; this would allow us to capture most of the use cases for
limited-private.
> Update Hadoop Common Site's
> ----------------------------
>
> Key: HADOOP-6775
> URL: https://issues.apache.org/jira/browse/HADOOP-6775
> Project: Hadoop Common
> Issue Type: Improvement
> Reporter: Sanjay Radia
> Assignee: Sanjay Radia
> Fix For: site
>
> Attachments: api_classification.pdf, siteCLassification.patch,
> siteCLassification2.patch, siteCLassification3.patch
>
>
> Add documentation on our interface classification scheme to thew common site.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
