001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2016 ForgeRock AS.
015 */
016
017package org.forgerock.api.enums;
018
019/**
020 * Represents API stability.
021 */
022public enum Stability {
023    /**
024     * Stable API (default), suggested for use by all clients.
025     */
026    STABLE,
027    /**
028     * Internal API that may change or be removed at any time.
029     */
030    INTERNAL,
031    /**
032     * Evolving API that may changed at any time.
033     */
034    EVOLVING,
035    /**
036     * Deprecated API, that should not be used and may be removed in the future.
037     */
038    DEPRECATED,
039    /**
040     * Removed API, that remains available for some technical reason and may return an error if used.
041     */
042    REMOVED;
043}