org.checkerframework.checker.mustcall

Interface CreatesObligationElementSupplier

All Known Implementing Classes:

MustCallAnnotatedTypeFactory

public interface CreatesObligationElementSupplier

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 getCreatesObligationExpressions(MethodInvocationNode, GenericAnnotatedTypeFactory, CreatesObligationElementSupplier) 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 ObjectConstruction/CalledMethods type factory and the MustCall type factory).

Method Summary

Modifier and Type	Method and Description
static @Nullable JavaExpression	getCreatesObligationExpression(AnnotationMirror createsObligation, MethodInvocationNode n, GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory, CreatesObligationElementSupplier supplier) Parses a single CreatesObligation annotation.
static List<JavaExpression>	getCreatesObligationExpressions(MethodInvocationNode n, GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory, CreatesObligationElementSupplier supplier) Returns the arguments of the @CreatesObligation annotation on the invoked method, as JavaExpressions.
ExecutableElement	getCreatesObligationListValueElement() Returns the CreatesObligation.List.value field/element.
ExecutableElement	getCreatesObligationValueElement() Returns the CreatesObligation.value field/element.
static void	issueUnparseableError(MethodInvocationNode n, GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory, String unparseable) Issues a createsobligation.target.unparseable error.

Method Detail

getCreatesObligationValueElement

ExecutableElement getCreatesObligationValueElement()

Returns the CreatesObligation.value field/element.

Returns:

the CreatesObligation.value field/element

getCreatesObligationListValueElement

ExecutableElement getCreatesObligationListValueElement()

Returns the CreatesObligation.List.value field/element.

Returns:

the CreatesObligation.List.value field/element

getCreatesObligationExpressions

static List<JavaExpression> getCreatesObligationExpressions(MethodInvocationNode n,
                                                            GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory,
                                                            CreatesObligationElementSupplier supplier)

Returns the arguments of the @CreatesObligation annotation on the invoked method, as JavaExpressions. Returns the empty set if the given method has no @CreatesObligation 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 CreatesObligation and CreatesObligation.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 @CreatesObligation annotation, or an empty list

getCreatesObligationExpression

static @Nullable JavaExpression getCreatesObligationExpression(AnnotationMirror createsObligation,
                                                               MethodInvocationNode n,
                                                               GenericAnnotatedTypeFactory<?,?,?,?> atypeFactory,
                                                               CreatesObligationElementSupplier supplier)

Parses a single CreatesObligation annotation. Clients should use getCreatesObligationExpressions(MethodInvocationNode, GenericAnnotatedTypeFactory, CreatesObligationElementSupplier), which handles the possibility of multiple such annotations, instead.

Parameters:

createsObligation - a @CreatesObligation annotation

n - the invocation of a reset method

atypeFactory - the type factory

supplier - a type factory that can supply the executable elements for CreatesObligation and CreatesObligation.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 createsobligation.target.unparseable error.

Parameters:

n - the node

atypeFactory - the type factory to use to issue the error

unparseable - the unparseable string