org.conqat.lib.commons.test.RequireThreadSafe Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of teamscale-lib-commons Show documentation

Provides common utility functions

There is a newer version: 2024.7.2

Show newest version

/*
 * Copyright (c) CQSE GmbH
 *
 * 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 org.conqat.lib.commons.test;

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;

import org.conqat.lib.commons.string.StringUtils;

/**
 * Can be used to explicitly mark classes/interfaces that require thread safety.
 * 
 * Subclasses must be annotated with {@link ThreadSafe} to state that they explicitly provide this
 * functionality.
 *
 * @implNote This is verified during test execution. However, it is not possible to verify this for
 *           implementations passed as lambdas, as they don't result in a class file.
 */
@Documented
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface RequireThreadSafe {

	/**
	 * @return A possible explanation why the class must be thread safe.
	 */
	String value() default StringUtils.EMPTY_STRING;
}