org.checkerframework.checker.mustcall

Interface CreatesMustCallForElementSupplier

All Known Implementing Classes:

MustCallAnnotatedTypeFactory, ResourceLeakAnnotatedTypeFactory

public interface CreatesMustCallForElementSupplier

This interface should be implemented by all type factories that can provide the ExecutableElement needed to call AnnotationUtils.getElementValueArray(javax.lang.model.element.AnnotationMirror, java.lang.CharSequence, java.lang.Class<T>, boolean) when getCreatesMustCallForExpressions(MethodInvocationNode, GenericAnnotatedTypeFactory, CreatesMustCallForElementSupplier) is called. This interface is needed so any type factory with these elements can be used to call that method, not just the MustCallAnnotatedTypeFactory (in particular, the consistency checker needs to be able to call that method with both the CalledMethods type factory and the MustCall type factory).

Method Summary

Modifier and Type	Method and Description
static @Nullable JavaExpression	getCreatesMustCallForExpression(AnnotationMirror createsMustCallFor, MethodInvocationNode n, GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory, CreatesMustCallForElementSupplier supplier) Parses a single CreatesMustCallFor annotation.
static List<JavaExpression>	getCreatesMustCallForExpressions(MethodInvocationNode n, GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory, CreatesMustCallForElementSupplier supplier) Returns the elements of the @CreatesMustCallFor annotation on the invoked method, as JavaExpressions.
ExecutableElement	getCreatesMustCallForListValueElement() Returns the CreatesMustCallFor.List.value field/element.
ExecutableElement	getCreatesMustCallForValueElement() Returns the CreatesMustCallFor.value field/element.
static void	issueUnparseableError(MethodInvocationNode n, GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory, String unparseable) Issues a createsmustcallfor.target.unparseable error.

Method Detail

getCreatesMustCallForValueElement

ExecutableElement getCreatesMustCallForValueElement()

Returns the CreatesMustCallFor.value field/element.

Returns:

the CreatesMustCallFor.value field/element

getCreatesMustCallForListValueElement

ExecutableElement getCreatesMustCallForListValueElement()

Returns the CreatesMustCallFor.List.value field/element.

Returns:

the CreatesMustCallFor.List.value field/element

getCreatesMustCallForExpressions

static List<JavaExpression> getCreatesMustCallForExpressions(MethodInvocationNode n,
                                                             GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory,
                                                             CreatesMustCallForElementSupplier supplier)

Returns the elements of the @CreatesMustCallFor annotation on the invoked method, as JavaExpressions. Returns the empty set if the given method has no @CreatesMustCallFor annotation.

If any expression is unparseable, this method reports an error and returns the empty set.

Parameters:

n - a method invocation

atypeFactory - the type factory to report errors and parse the expression string

supplier - a type factory that can supply the executable elements for CreatesMustCallFor and CreatesMustCallFor.List's value elements. Usually, you should just pass atypeFactory again. The arguments are different so that the given type factory's adherence to both protocols are checked by the type system.

Returns:

the arguments of the method's @CreatesMustCallFor annotation, or an empty list

getCreatesMustCallForExpression

static @Nullable JavaExpression getCreatesMustCallForExpression(AnnotationMirror createsMustCallFor,
                                                                MethodInvocationNode n,
                                                                GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory,
                                                                CreatesMustCallForElementSupplier supplier)

Parses a single CreatesMustCallFor annotation. Clients should use getCreatesMustCallForExpressions(MethodInvocationNode, GenericAnnotatedTypeFactory, CreatesMustCallForElementSupplier), which handles the possibility of multiple such annotations, instead.

Parameters:

createsMustCallFor - a @CreatesMustCallFor annotation

n - the invocation of a reset method

atypeFactory - the type factory

supplier - a type factory that can supply the executable elements for CreatesMustCallFor and CreatesMustCallFor.List's value elements. Usually, you should just pass atypeFactory again. The arguments are different so that the given type factory's adherence to both protocols are checked by the type system.

Returns:

the Java expression representing the target, or null if the target is unparseable

issueUnparseableError

static void issueUnparseableError(MethodInvocationNode n,
                                  GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory,
                                  String unparseable)

Issues a createsmustcallfor.target.unparseable error.

Parameters:

n - the node

atypeFactory - the type factory to use to issue the error

unparseable - the unparseable string