com.couchbase.columnar.client.java.internal.ThreadSafe Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 Couchbase, Inc.
 *
 * 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.couchbase.columnar.client.java.internal;

import org.jetbrains.annotations.ApiStatus;

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;

/**
 * Documents that the annotated type is thread-safe.
 * 
 * When applied to an interface or abstract class,
 * documents that implementations and subclasses must be thread-safe.
 * 
 * This annotation only provides information; nothing magical happens
 * when it is present. The implementor of the annotated class/interface
 * is responsible for ensuring it is actually thread-safe.
 */
@ApiStatus.Internal
@Retention(RetentionPolicy.SOURCE)
@Documented
@Target(ElementType.TYPE)
public @interface ThreadSafe {
  String caveat() default "";
}