• Home
• org.mongodb
• mongodb-driver-core
• 5.0.1
• source code
• Evolving.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.mongodb.annotations.Evolving Maven / Gradle / Ivy

/*
 * Copyright 2008-present MongoDB, Inc.
 * Copyright 2010 The Guava Authors
 * Copyright 2011 The Guava Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.mongodb.annotations;

import org.bson.codecs.Codec;
import org.bson.conversions.Bson;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Signifies that the annotated program element is subject to incompatible changes by means of adding abstract methods.
 * This, in turn, means that implementing interfaces or extending classes annotated with {@link Evolving} bears the risk
 * of doing extra work during upgrades.
 * Using such program elements is no different from using ordinary unannotated program elements.
 * Note that the presence of this annotation implies nothing about the quality or performance of the API in question.
 * 

 * Unless we currently want to allow users to extend/implement API program elements, we must annotate them with
 * {@code @}{@link Sealed} rather than {@code @}{@link Evolving}. Replacing {@code @}{@link Sealed} with {@code @}{@link Evolving}
 * is a backward-compatible change, while the opposite is not.
 *
 * 
 *   
 *   
 *     
 *     
 *     
 *   
 *   
 *     
 *     
 *     
 *   
 *   
 *     
 *     
 *     
 *   
 *   
 *     
 *     
 *     
 *   
 *   
 *     
 *     
 *     
 *   
 * 
Reasons we may allow users to extend/implement an API program element
Reason
Example
Applicability of {@code @}{@link Evolving}
Doing so allows/simplifies integrating user code with the API.
{@link Bson}
Not applicable.
Doing so allows customizing API behavior.
{@link Codec}
Not applicable.
Doing so facilitates writing application unit tests by creating a fake implementation.
{@code com.mongodb.client.MongoClient}
Applicable.
The program element was introduced before {@code @}{@link Evolving}.
{@code com.mongodb.client.MongoClient}
Applicable.
 *
 * @see Sealed
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
@Documented
@Evolving
public @interface Evolving {
}