[
https://issues.apache.org/jira/browse/HADOOP-3944?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12623834#action_12623834
]
Michael Andrews commented on HADOOP-3944:
-----------------------------------------
If the join package is only used internally, then javadoc can still be
generated by using the -private flag (there is also an ant parameter that sets
this in the javadoc target). A developer javadoc target could be added, which
most end users won't use (ala dist, or maintainer-mode). This idea falls apart
if end users also need access to the join package.
> TupleWritable listed as public class but cannot be used without methods
> private to the package
> ----------------------------------------------------------------------------------------------
>
> Key: HADOOP-3944
> URL: https://issues.apache.org/jira/browse/HADOOP-3944
> Project: Hadoop Core
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 0.17.1
> Reporter: Michael Andrews
> Priority: Minor
>
> Reading the hadoop-core javadocs, it appears as though TupleWritable can be
> used outside of the
> org.apache.hadoop.mapred.join.* package. A user can import TupleWritable but
> cannot use it correctly without the setWritten, and clearWritten methods
> being public. It seems as the though the intent was to make TupleWritable
> hidden from the user as it is dependent on CompositeRecordReader. As a
> possible solution, classes within a package can be made invisible to the user
> by omitting 'public' from the class definition. In the case of
> TupleWritable, this removes the javadoc link from other classes in
> mapred.join and it's not clear if these classes should be hidden from the
> user.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
