001/*
002 * (C) Copyright 2015 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl-2.1.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     jcarsique
016 */
017package org.nuxeo.common.annotation;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025/**
026 * Signifies that annotated API is still in early stage and subject to incompatible changes, or even removal, in a
027 * future release. The presence of this annotation implies nothing about the code quality or performance, only the fact
028 * that the API is not yet "frozen".
029 * <p>
030 * It is generally safe to depend on Experimental APIs, at the prospective cost of some extra work during upgrades. The
031 * API <code>@Since</code> annotation gives a preview on how much mature it is and the chances for the
032 * <code>@Experimental</code> annotation being soon removed.
033 *
034 * @since 7.2
035 */
036@Retention(RetentionPolicy.RUNTIME)
037@Target({ ElementType.PACKAGE, ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE })
038@Documented
039@Experimental
040public @interface Experimental {
041    String comment() default "";
042}