com.hazelcast.org.checkerframework.checker.lock.qual.NewObject Maven / Gradle / Ivy
package com.hazelcast.org.checkerframework.checker.lock.qual;
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 com.hazelcast.org.checkerframework.framework.qual.DefaultFor;
import com.hazelcast.org.checkerframework.framework.qual.LiteralKind;
import com.hazelcast.org.checkerframework.framework.qual.QualifierForLiterals;
import com.hazelcast.org.checkerframework.framework.qual.SubtypeOf;
import com.hazelcast.org.checkerframework.framework.qual.TargetLocations;
import com.hazelcast.org.checkerframework.framework.qual.TypeUseLocation;
/**
* A type that represents a newly-constructed object. It can be treated as having any
* {@code @}{@link GuardedBy} type. Typically, it is only written on factory method return types.
*
* @checker_framework.manual #lock-checker Lock Checker
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})
@TargetLocations({TypeUseLocation.EXPLICIT_LOWER_BOUND, TypeUseLocation.EXPLICIT_UPPER_BOUND})
@SubtypeOf({GuardedBy.class, GuardSatisfied.class})
@DefaultFor(TypeUseLocation.CONSTRUCTOR_RESULT)
@QualifierForLiterals({LiteralKind.STRING, LiteralKind.PRIMITIVE})
public @interface NewObject {}