com.asakusafw.operator

Interface OperatorDriver

All Known Implementing Classes:

BranchOperatorDriver, CoGroupOperatorDriver, ConvertOperatorDriver, ExtractOperatorDriver, FoldOperatorDriver, GroupSortOperatorDriver, LoggingOperatorDriver, MasterBranchOperatorDriver, MasterCheckOperatorDriver, MasterJoinOperatorDriver, MasterJoinUpdateOperatorDriver, SplitOperatorDriver, SummarizeOperatorDriver, UpdateOperatorDriver

public interface OperatorDriver

A service interface that supports new Asakusa Operator DSL annotations.

Adding a new operator annotations to Operator DSL compiler, clients can implement this and put the class name in META-INF/services/com.asakusafw.lang.compiler.operator.OperatorDriver.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OperatorDriver.Context Represents processing context.

Method Summary

Modifier and Type	Method and Description
OperatorDescription	analyze(OperatorDriver.Context context) Analyzes the operator method and returns its description.
ClassDescription	getAnnotationTypeName() Returns the target annotation type name.
default Iterable<? extends Completion>	getCompletions(OperatorDriver.Context context, ExecutableElement member, String userText) Returns a list of proposals about target annotation element.

Method Detail

getAnnotationTypeName

ClassDescription getAnnotationTypeName()

Returns the target annotation type name.

Returns:

the target annotation type name

analyze

OperatorDescription analyze(OperatorDriver.Context context)

Analyzes the operator method and returns its description. If failed to analyze the target method, this method returns null.

Parameters:

context - target context

Returns:

related description

getCompletions

default Iterable<? extends Completion> getCompletions(OperatorDriver.Context context,
                                                      ExecutableElement member,
                                                      String userText)

Returns a list of proposals about target annotation element.

Parameters:

context - target context

member - target annotation element

userText - user's text

Returns:

list of proposals, or an empty list

Throws:

IllegalArgumentException - if some parameters were null

See Also:

Completions