Package org.incendo.cloud.annotations.extractor

Class StandardArgumentExtractor

java.lang.Object

org.incendo.cloud.annotations.extractor.StandardArgumentExtractor

All Implemented Interfaces:

ArgumentExtractor

Direct Known Subclasses:

ImmutableStandardArgumentExtractor

@Immutable
public abstract class StandardArgumentExtractor
extends Object
implements ArgumentExtractor

Utility that extract arguments from method parameters

Constructor Summary

Constructors

Constructor	Description
StandardArgumentExtractor()

Method Summary

Modifier and Type	Method	Description
abstract @NonNull AnnotationParser<?>	annotationParser()	Returns the annotation parser.
static @NonNull ImmutableStandardArgumentExtractor.Builder	builder(@NonNull AnnotationParser<?> annotationParser)	Returns a builder that builds StandardArgumentExtractor instances.
static @NonNull ImmutableStandardArgumentExtractor.Builder	builder(@NonNull StandardArgumentExtractor extractor)	Returns a builder that builds StandardArgumentExtractor instances.
static @NonNull StandardArgumentExtractor	create(@NonNull AnnotationParser<?> annotationParser)	Returns a StandardArgumentExtractor with the default options.
@NonNull DescriptionMapper	descriptionMapper()	Returns the description mapper.
final @NonNull Collection<@NonNull ArgumentDescriptor>	extractArguments(@NonNull List<@NonNull SyntaxFragment> syntax, @NonNull Method method)	Extracts the arguments from the given method.
@NonNull ParameterNameExtractor	parameterNameExtractor()	Returns the ParameterNameExtractor which is responsible for mapping parameters to syntax fragments in the case that a named @Argument annotation is not present.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StandardArgumentExtractor

public StandardArgumentExtractor()

Method Details

create

public static @NonNull StandardArgumentExtractor create(@NonNull AnnotationParser<?> annotationParser)

Returns a StandardArgumentExtractor with the default options.

Parameters:

annotationParser - the annotation parser

Returns:

the argument extractor

builder

public static @NonNull ImmutableStandardArgumentExtractor.Builder builder(@NonNull AnnotationParser<?> annotationParser)

Returns a builder that builds StandardArgumentExtractor instances.

Parameters:

annotationParser - the annotation parser

Returns:

the builder

builder

public static @NonNull ImmutableStandardArgumentExtractor.Builder builder(@NonNull StandardArgumentExtractor extractor)

Returns a builder that builds StandardArgumentExtractor instances.

Parameters:

extractor - the extractor to copy from

Returns:

the builder

annotationParser

public abstract @NonNull AnnotationParser<?> annotationParser()

Returns the annotation parser.

Returns:

the annotation parser

parameterNameExtractor

@Default
public @NonNull ParameterNameExtractor parameterNameExtractor()

Returns the ParameterNameExtractor which is responsible for mapping parameters to syntax fragments in the case that a named @Argument annotation is not present.

Returns:

the parameter name extractor

descriptionMapper

@Default
public @NonNull DescriptionMapper descriptionMapper()

Returns the description mapper.

Returns:

the description mapper

extractArguments

public final @NonNull Collection<@NonNull ArgumentDescriptor> extractArguments(@NonNull List<@NonNull SyntaxFragment> syntax,
 @NonNull Method method)

Description copied from interface: ArgumentExtractor

Extracts the arguments from the given method.

Specified by:

extractArguments in interface ArgumentExtractor

Parameters:

syntax - the syntax of the command

method - the method

Returns:

the extracted arguments