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 import org.apache.hadoop.hbase.classification.InterfaceAudience.LimitedPrivate; 25 import org.apache.hadoop.hbase.classification.InterfaceAudience.Private; 26 import org.apache.hadoop.hbase.classification.InterfaceAudience.Public; 27 28 /** 29 * Annotation to inform users of how much to rely on a particular package, 30 * class or method not changing over time. Currently the stability can be 31 * {@link Stable}, {@link Evolving} or {@link Unstable}. <br> 32 * 33 * <ul><li>All classes that are annotated with {@link Public} or 34 * {@link LimitedPrivate} must have InterfaceStability annotation. </li> 35 * <li>Classes that are {@link Private} are to be considered unstable unless 36 * a different InterfaceStability annotation states otherwise.</li> 37 * <li>Incompatible changes must not be made to classes marked as stable.</li> 38 * </ul> 39 */ 40 @InterfaceAudience.Public 41 @InterfaceStability.Evolving 42 public class InterfaceStability { 43 /** 44 * Can evolve while retaining compatibility for minor release boundaries.; 45 * can break compatibility only at major release (ie. at m.0). 46 */ 47 @Documented 48 @Retention(RetentionPolicy.RUNTIME) 49 public @interface Stable {}; 50 51 /** 52 * Evolving, but can break compatibility at minor release (i.e. m.x) 53 */ 54 @Documented 55 @Retention(RetentionPolicy.RUNTIME) 56 public @interface Evolving {}; 57 58 /** 59 * No guarantee is provided as to reliability or stability across any 60 * level of release granularity. 61 */ 62 @Documented 63 @Retention(RetentionPolicy.RUNTIME) 64 public @interface Unstable {}; 65 }