View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.apache.hadoop.hbase.classification;
19  
20  import java.lang.annotation.Documented;
21  import java.lang.annotation.Retention;
22  import java.lang.annotation.RetentionPolicy;
23  
24  
25  /**
26   * Annotation to inform users of how much to rely on a particular package,
27   * class or method not changing over time. Currently the stability can be
28   * {@link Stable}, {@link Evolving} or {@link Unstable}. <br>
29   *
30   * <ul><li>All classes that are annotated with 
31   * {@link org.apache.hadoop.hbase.classification.InterfaceAudience.Public} or
32   * {@link org.apache.hadoop.hbase.classification.InterfaceAudience.LimitedPrivate} 
33   * must have InterfaceStability annotation. </li>
34   * <li>Classes that are 
35   * {@link org.apache.hadoop.hbase.classification.InterfaceAudience.LimitedPrivate} 
36   * are to be considered unstable unless a different InterfaceStability annotation
37   *  states otherwise.</li>
38   * <li>Incompatible changes must not be made to classes marked as stable.</li>
39   * </ul>
40   */
41  @InterfaceAudience.Public
42  @InterfaceStability.Evolving
43  public class InterfaceStability {
44    /**
45     * Can evolve while retaining compatibility for minor release boundaries.;
46     * can break compatibility only at major release (ie. at m.0).
47     */
48    @Documented
49    @Retention(RetentionPolicy.RUNTIME)
50    public @interface Stable {};
51  
52    /**
53     * Evolving, but can break compatibility at minor release (i.e. m.x)
54     */
55    @Documented
56    @Retention(RetentionPolicy.RUNTIME)
57    public @interface Evolving {};
58  
59    /**
60     * No guarantee is provided as to reliability or stability across any
61     * level of release granularity.
62     */
63    @Documented
64    @Retention(RetentionPolicy.RUNTIME)
65    public @interface Unstable {};
66  }