mcvsubbu commented on a change in pull request #4063: Introduce interface stability and audience annotations URL: https://github.com/apache/incubator-pinot/pull/4063#discussion_r271942842
########## File path: pinot-common/src/main/java/org/apache/pinot/annotations/InterfaceAudience.java ########## @@ -0,0 +1,72 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.pinot.annotations; + +import java.lang.annotation.Documented; + + +/** + * Annotation to inform users of a package, class or method's intended audience. + * + * Currently the audience can be {@link org.apache.pinot.annotations.InterfaceAudience.Public}, + * {@link org.apache.pinot.annotations.InterfaceAudience.LimitedPrivate} or + * {@link org.apache.pinot.annotations.InterfaceAudience.Private}. <br> + * It is recommended that public classes are annotated with InterfaceAudience annotation. <br> + * <ul> + * <li>Public classes that are not marked with this annotation must be + * considered by default as {@link org.apache.pinot.annotations.InterfaceAudience.Private}.</li> + * + * <li>External applications must only use classes that are marked + * {@link org.apache.pinot.annotations.InterfaceAudience.Public}. Do not depend on non-public classes as these classes Review comment: I may change "non-public classes" to "classes not marked thus" (the word public here is too generic) ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
