Top Description Inners Methods
org.checkerframework.framework.qual

public @Interface RequiresQualifier

extends Annotation
Annotations
@Documented
@Retention:RUNTIME
@Target:METHOD, CONSTRUCTOR
@Repeatable:List
Imports
java.lang.annotation.Annotation, .Documented, .ElementType, .Repeatable, .Retention, .RetentionPolicy, .Target

A precondition annotation to indicate that a method requires certain expressions to have a certain qualifier at the time of the call to the method. The expressions for which the annotation must hold after the method's execution are indicated by expression and are specified using a string. The qualifier is specified by qualifier.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static @interface
RequiresQualifier.List

A wrapper annotation that makes the RequiresQualifier annotation repeatable.

Method Summary

Modifier and TypeMethod and Description
public String[]

Returns:

the Java expressions for which the annotation need to be present
expression
()

Returns the Java expressions for which the annotation need to be present.

public Class<? extends Annotation>

Returns:

the qualifier that is required
qualifier
()

Returns the qualifier that is required.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

expressionback to summary
public String[] expression()

Returns the Java expressions for which the annotation need to be present.

Returns:String[]

the Java expressions for which the annotation need to be present

qualifierback to summary
public Class<? extends Annotation> qualifier()

Returns the qualifier that is required.

Returns:Class<? extends Annotation>

the qualifier that is required

org.checkerframework.framework.qual back to summary

public @Interface RequiresQualifier.List

extends Annotation
Annotations
@Documented
@Retention:RUNTIME
@Target:METHOD, CONSTRUCTOR

A wrapper annotation that makes the RequiresQualifier annotation repeatable.

Programmers generally do not need to write this. It is created by Java when a programmer writes more than one RequiresQualifier annotation at the same location.

Method Summary

Modifier and TypeMethod and Description
public RequiresQualifier[]

Returns:

the repeatable annotations
value
()

Returns the repeatable annotations.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public RequiresQualifier[] value()

Returns the repeatable annotations.

Returns:RequiresQualifier[]

the repeatable annotations