Home | History | Annotate | Download | only in protobuf
      1 // Protocol Buffers - Google's data interchange format
      2 // Copyright 2008 Google Inc.  All rights reserved.
      3 // https://developers.google.com/protocol-buffers/
      4 //
      5 // Redistribution and use in source and binary forms, with or without
      6 // modification, are permitted provided that the following conditions are
      7 // met:
      8 //
      9 //     * Redistributions of source code must retain the above copyright
     10 // notice, this list of conditions and the following disclaimer.
     11 //     * Redistributions in binary form must reproduce the above
     12 // copyright notice, this list of conditions and the following disclaimer
     13 // in the documentation and/or other materials provided with the
     14 // distribution.
     15 //     * Neither the name of Google Inc. nor the names of its
     16 // contributors may be used to endorse or promote products derived from
     17 // this software without specific prior written permission.
     18 //
     19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     30 
     31 package com.google.protobuf;
     32 
     33 import java.lang.annotation.Documented;
     34 import java.lang.annotation.ElementType;
     35 import java.lang.annotation.Retention;
     36 import java.lang.annotation.RetentionPolicy;
     37 import java.lang.annotation.Target;
     38 
     39 /**
     40  * Indicates a public API that can change at any time, and has no guarantee of API stability and
     41  * backward-compatibility.
     42  *
     43  * <p>Usage guidelines:
     44  * <ol>
     45  * <li>This annotation is used only on public API. Internal interfaces should not use it.</li>
     46  * <li>This annotation should only be added to new APIs. Adding it to an existing API is
     47  * considered API-breaking.</li>
     48  * <li>Removing this annotation from an API gives it stable status.</li>
     49  * </ol>
     50  */
     51 @Retention(RetentionPolicy.SOURCE)
     52 @Target({
     53     ElementType.ANNOTATION_TYPE,
     54     ElementType.CONSTRUCTOR,
     55     ElementType.FIELD,
     56     ElementType.METHOD,
     57     ElementType.PACKAGE,
     58     ElementType.TYPE})
     59 @Documented
     60 public @interface ExperimentalApi {
     61   /**
     62    * Context information such as links to discussion thread, tracking issue etc.
     63    */
     64   String value() default "";
     65 }
     66 
     67