io.micronaut.data.processor.visitors.finders

Interface MethodCandidate

All Superinterfaces:

io.micronaut.core.order.Ordered

All Known Implementing Classes:

AbstractListMethod, AbstractPatternBasedMethod, CountByMethod, CountMethod, CountSpecificationMethod, DeleteByMethod, DeleteMethod, DynamicFinder, ExistsByFinder, FindAllSpecificationMethod, FindByFinder, FindByIdsMethod, FindOneMethod, FindOneSpecificationMethod, FindPageByMethod, FindPageSpecificationMethod, FindSliceByMethod, ListMethod, ListPageMethod, ListSliceMethod, SaveAllMethod, SaveEntityMethod, SaveOneMethod, UpdateByMethod, UpdateEntityMethod, UpdateMethod

public interface MethodCandidate
extends io.micronaut.core.order.Ordered

Implementation of dynamic finders.

Since:

1.0

Author:

graeme rocher

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_POSITION The default position.

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
MethodMatchInfo	buildMatchInfo(MethodMatchContext matchContext) Builds the method info.
default int	getOrder()
boolean	isMethodMatch(io.micronaut.inject.ast.MethodElement methodElement, MatchContext matchContext) Whether the given method name matches this finder.

Field Detail

DEFAULT_POSITION

static final int DEFAULT_POSITION

The default position.

See Also:

Constant Field Values

Method Detail

isMethodMatch

boolean isMethodMatch(@NonNull
                      io.micronaut.inject.ast.MethodElement methodElement,
                      @NonNull
                      MatchContext matchContext)

Whether the given method name matches this finder.

Parameters:

methodElement - The method element. Never null.

matchContext - The match context. Never null.

Returns:

true if it does

getOrder

default int getOrder()

Specified by:

getOrder in interface io.micronaut.core.order.Ordered

buildMatchInfo

@Nullable
MethodMatchInfo buildMatchInfo(@NonNull
                                         MethodMatchContext matchContext)

Builds the method info. The method isMethodMatch(MethodElement, MatchContext) should be invoked and checked prior to calling this method.

Parameters:

matchContext - The match context

Returns:

The method info or null if it cannot be built. If the method info cannot be built an error will be reported to the passed MethodMatchContext