Return-Path: 
 <common-issues-return-8386-apmail-hadoop-common-issues-archive=hadoop.apache.org@hadoop.apache.org>
Delivered-To: apmail-hadoop-common-issues-archive@minotaur.apache.org
Received: (qmail 52481 invoked from network); 20 May 2010 23:58:38 -0000
Received: from unknown (HELO mail.apache.org) (140.211.11.3)
  by 140.211.11.9 with SMTP; 20 May 2010 23:58:38 -0000
Received: (qmail 48963 invoked by uid 500); 20 May 2010 23:58:38 -0000
Delivered-To: apmail-hadoop-common-issues-archive@hadoop.apache.org
Received: (qmail 48849 invoked by uid 500); 20 May 2010 23:58:38 -0000
Mailing-List: contact common-issues-help@hadoop.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:common-issues-help@hadoop.apache.org>
List-Unsubscribe: <mailto:common-issues-unsubscribe@hadoop.apache.org>
List-Post: <mailto:common-issues@hadoop.apache.org>
List-Id: <common-issues.hadoop.apache.org>
Reply-To: common-issues@hadoop.apache.org
Delivered-To: mailing list common-issues@hadoop.apache.org
Received: (qmail 48841 invoked by uid 99); 20 May 2010 23:58:38 -0000
Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136)
    by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 20 May 2010 23:58:38 +0000
X-ASF-Spam-Status: No, hits=-1450.2 required=10.0
	tests=ALL_TRUSTED,AWL
X-Spam-Check-By: apache.org
Received: from [140.211.11.22] (HELO thor.apache.org) (140.211.11.22)
    by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 20 May 2010 23:58:38 +0000
Received: from thor (localhost [127.0.0.1])
	by thor.apache.org (8.13.8+Sun/8.13.8) with ESMTP id o4KNwHik006128
	for <common-issues@hadoop.apache.org>; Thu, 20 May 2010 23:58:17 GMT
Message-ID: <18745353.9161274399897649.JavaMail.jira@thor>
Date: Thu, 20 May 2010 19:58:17 -0400 (EDT)
From: "Sanjay Radia (JIRA)" <jira@apache.org>
To: common-issues@hadoop.apache.org
Subject: [jira] Commented: (HADOOP-6775) Update Hadoop Common Site's
In-Reply-To: <5305625.23361274301713697.JavaMail.jira@thor>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394


    [ https://issues.apache.org/jira/browse/HADOOP-6775?page=3Dcom.atlassia=
n.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=3D128=
69814#action_12869814 ]=20

Sanjay Radia commented on HADOOP-6775:
--------------------------------------

I was planning to add the following item to the FAQ section. Would this add=
ress your comment?

<add to FAQ section>
How does the classification relate to the Java's visibility declaration?

Java allows public, private and protected declarations.=20
=E2=80=A2=09A java-private element is always audience-private.
=E2=80=A2=09An audience-public element is always java-public; the reverse i=
s 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.=20
=E2=80=A2=09A java-protected element may be audience-private (for internal =
sub-classing within an implementation), or audience-public if it is intende=
d for general use (as with HDFS's AbstractFileSystem class).=20
=E2=80=A2=09If JSR-294 completes (currently inactive) it will likely help i=
n aligning our classification with the Java visibility rules: it appears th=
at 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 li=
mited-private.


> Update Hadoop Common Site's=20
> ----------------------------
>
>                 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, si=
teCLassification2.patch, siteCLassification3.patch
>
>
> Add documentation on our interface classification scheme to thew common s=
ite.

--=20
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.