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> <li>Classes that are 
34   * {@link org.apache.hadoop.hbase.classification.InterfaceAudience.LimitedPrivate} 
35   * are to be considered unstable unless a different InterfaceStability annotation 
36   * states otherwise.</li> <li>Incompatible changes must not be made to classes 
37   * marked as stable.</li> </ul>
38   */
39  @InterfaceAudience.Public
40  @InterfaceStability.Evolving
41  public class InterfaceStability {
42    /**
43     * Can evolve while retaining compatibility for minor release boundaries.;
44     * can break compatibility only at major release (ie. at m.0).
45     */
46    @Documented
47    @Retention(RetentionPolicy.RUNTIME)
48    public @interface Stable {};
49  
50    /**
51     * Evolving, but can break compatibility at minor release (i.e. m.x)
52     */
53    @Documented
54    @Retention(RetentionPolicy.RUNTIME)
55    public @interface Evolving {};
56  
57    /**
58     * No guarantee is provided as to reliability or stability across any
59     * level of release granularity.
60     */
61    @Documented
62    @Retention(RetentionPolicy.RUNTIME)
63    public @interface Unstable {};
64  }