All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.checkerframework.checker.lock.qual.EnsuresLockHeld Maven / Gradle / Ivy

Go to download

checker-qual contains annotations (type qualifiers) that a programmer writes to specify Java code for type-checking by the Checker Framework.

The newest version!
package org.checkerframework.checker.lock.qual;

import org.checkerframework.framework.qual.InheritedAnnotation;
import org.checkerframework.framework.qual.PostconditionAnnotation;

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

/**
 * Indicates that the given expressions are held if the method terminates successfully.
 *
 * @see EnsuresLockHeldIf
 * @checker_framework.manual #lock-checker Lock Checker
 * @checker_framework.manual #ensureslockheld-examples Example use of @EnsuresLockHeld
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
@PostconditionAnnotation(qualifier = LockHeld.class)
@InheritedAnnotation
@Repeatable(EnsuresLockHeld.List.class)
public @interface EnsuresLockHeld {
    /**
     * Returns Java expressions whose values are locks that are held after successful method
     * termination.
     *
     * @return Java expressions whose values are locks that are held after successful method
     *     termination
     * @see Syntax of
     *     Java expressions
     */
    String[] value();

    /**
     * A wrapper annotation that makes the {@link EnsuresLockHeld} annotation repeatable.
     *
     * 

Programmers generally do not need to write this. It is created by Java when a programmer * writes more than one {@link EnsuresLockHeld} annotation at the same location. */ @Documented @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.METHOD, ElementType.CONSTRUCTOR}) @PostconditionAnnotation(qualifier = LockHeld.class) @InheritedAnnotation public static @interface List { /** * Return the repeatable annotations. * * @return the repeatable annotations */ EnsuresLockHeld[] value(); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy