001/*
002 * (C) Copyright 2015 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     jcarsique
018 */
019package org.nuxeo.common.annotation;
020
021import java.lang.annotation.Documented;
022import java.lang.annotation.ElementType;
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025import java.lang.annotation.Target;
026
027/**
028 * Signifies that annotated API is still in early stage and subject to incompatible changes, or even removal, in a
029 * future release. The presence of this annotation implies nothing about the code quality or performance, only the fact
030 * that the API is not yet "frozen".
031 * <p>
032 * It is generally safe to depend on Experimental APIs, at the prospective cost of some extra work during upgrades. The
033 * API <code>@Since</code> annotation gives a preview on how much mature it is and the chances for the
034 * <code>@Experimental</code> annotation being soon removed.
035 *
036 * @since 7.2
037 */
038@Retention(RetentionPolicy.RUNTIME)
039@Target({ ElementType.PACKAGE, ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE })
040@Documented
041@Experimental
042public @interface Experimental {
043    String comment() default "";
044}