The interface audience and stability annotations are a great idea to use. Please use the publicly-consumable ones in Apache Yetus instead of those in Hadoop. :)
http://yetus.apache.org/documentation/0.1.0/audience-annotations-apidocs/ On Tue, Jan 5, 2016 at 7:34 PM, Matthew Burgess <[email protected]> wrote: > That’s my bad, and I can’t blame bourbon this time :) > > Hadoop has an annotation class for InterfaceStability [1]. It is used to > annotate interfaces with a “contract” about whether they are likely to change > or not (example [2]). They use values like Stable, Unstable, and Evolving, > explained in javadoc [3]. I thought maybe this was the kind of thing you > were referring to when you mentioned annotating NiFi classes with a sort of > contract about their potential volatility? > > Regards, > Matt > > [1] > https://hadoop.apache.org/docs/r2.7.0/api/org/apache/hadoop/classification/InterfaceStability.html > [2] > https://hadoop.apache.org/docs/r2.7.0/api/org/apache/hadoop/yarn/api/records/ContainerReport.html > [3] > https://hadoop.apache.org/docs/r2.7.0/api/src-html/org/apache/hadoop/classification/InterfaceStability.html#line.42 > > > > > > On 1/5/16, 7:43 PM, "Tony Kurc" <[email protected]> wrote: > >>I think I parsed your sentence differently than you intended. Was your >>"this" in your opening sentence "what Tony described" or "what Matt is >>going describe"? >>On Jan 5, 2016 7:35 PM, "Matt Burgess" <[email protected]> wrote: >> >>> Roger that. This is what Hadoop does, for an API method (class, etc.) in >>> Java it is annotated as @Stable or @Unstable. I was just referring to the >>> semantics of when you might expect an @Unstable method to change, for >>> example. Or am I still misunderstanding what you mean? >>> >>> Regards, >>> Matt >>> >>> Sent from my iPhone >>> >>> > On Jan 5, 2016, at 7:29 PM, Tony Kurc <[email protected]> wrote: >>> > >>> > Matt, >>> > What I'm talking about is annotating individual fields, methods, and >>> > classes, giving some contract other than the access modifiers of java. >>> > -- Sean
