Package org.incendo.cloud.parser

Interface ParserDescriptor<C,T>

All Known Subinterfaces:

AggregateParser<C,O>

@Immutable
@API(status=STABLE)
public interface ParserDescriptor<C,T>

Method Summary

Modifier and Type	Method	Description
default <O> @NonNull ParserDescriptor<C,O>	flatMap(@NonNull TypeToken<O> mappedType, @NonNull MappedArgumentParser.Mapper<C,T,O> mapper)	Create a descriptor for a flatMapped parser.
default <O> @NonNull ParserDescriptor<C,O>	flatMap(@NonNull Class<O> mappedType, @NonNull MappedArgumentParser.Mapper<C,T,O> mapper)	Create a descriptor for a flatMapped parser.
default <O> @NonNull ParserDescriptor<C,O>	flatMapSuccess(@NonNull TypeToken<O> mappedType, @NonNull BiFunction<CommandContext<C>,T,CompletableFuture<ArgumentParseResult<O>>> mapper)	Create a descriptor for a flatMapped parser.
default <O> @NonNull ParserDescriptor<C,O>	flatMapSuccess(@NonNull Class<O> mappedType, @NonNull BiFunction<CommandContext<C>,T,CompletableFuture<ArgumentParseResult<O>>> mapper)	Create a descriptor for a flatMapped parser.
default <O> @NonNull ParserDescriptor<C,O>	mapSuccess(@NonNull TypeToken<O> mappedType, @NonNull BiFunction<CommandContext<C>,T,CompletableFuture<O>> mapper)	Create a descriptor for a mapped parser.
default <O> @NonNull ParserDescriptor<C,O>	mapSuccess(@NonNull Class<O> mappedType, @NonNull BiFunction<CommandContext<C>,T,CompletableFuture<O>> mapper)	Create a descriptor for a mapped parser.
static <C, T> @NonNull ParserDescriptor<C,T>	of(@NonNull ArgumentParser<C,T> parser, @NonNull TypeToken<T> valueType)	Creates a new parser descriptor.
static <C, T> @NonNull ParserDescriptor<C,T>	of(@NonNull ArgumentParser<C,T> parser, @NonNull Class<T> valueType)	Creates a new parser descriptor.
@NonNull ArgumentParser<C,T>	parser()	Returns the parser.
static <C, T> @NonNull ParserDescriptor<C,T>	parserDescriptor(@NonNull ArgumentParser<C,T> parser, @NonNull TypeToken<T> valueType)	Creates a new parser descriptor.
static <C, T> @NonNull ParserDescriptor<C,T>	parserDescriptor(@NonNull ArgumentParser<C,T> parser, @NonNull Class<T> valueType)	Creates a new parser descriptor.
@NonNull TypeToken<T>	valueType()	Returns the type of values produced by the parser.

Method Details

parser

@NonNull ArgumentParser<C,T> parser()

Returns the parser.

Returns:

the parser

valueType

@NonNull TypeToken<T> valueType()

Returns the type of values produced by the parser.

Returns:

the type of values produced by the parser

flatMap

default <O> @NonNull ParserDescriptor<C,O> flatMap(@NonNull TypeToken<O> mappedType,
 @NonNull MappedArgumentParser.Mapper<C,T,O> mapper)

Create a descriptor for a flatMapped parser.

Type Parameters:

O - mapped parser result type

Parameters:

mappedType - mapped parser result type

mapper - mapper

Returns:

mapped parser descriptor

flatMap

default <O> @NonNull ParserDescriptor<C,O> flatMap(@NonNull Class<O> mappedType,
 @NonNull MappedArgumentParser.Mapper<C,T,O> mapper)

Create a descriptor for a flatMapped parser.

Type Parameters:

O - mapped parser result type

Parameters:

mappedType - mapped parser result type

mapper - mapper

Returns:

mapped parser descriptor

flatMapSuccess

default <O> @NonNull ParserDescriptor<C,O> flatMapSuccess(@NonNull TypeToken<O> mappedType,
 @NonNull BiFunction<CommandContext<C>,T,CompletableFuture<ArgumentParseResult<O>>> mapper)

Create a descriptor for a flatMapped parser.

Type Parameters:

O - mapped parser result type

Parameters:

mappedType - mapped parser result type

mapper - mapper

Returns:

mapped parser descriptor

flatMapSuccess

default <O> @NonNull ParserDescriptor<C,O> flatMapSuccess(@NonNull Class<O> mappedType,
 @NonNull BiFunction<CommandContext<C>,T,CompletableFuture<ArgumentParseResult<O>>> mapper)

Create a descriptor for a flatMapped parser.

Type Parameters:

O - mapped parser result type

Parameters:

mappedType - mapped parser result type

mapper - mapper

Returns:

mapped parser descriptor

mapSuccess

default <O> @NonNull ParserDescriptor<C,O> mapSuccess(@NonNull TypeToken<O> mappedType,
 @NonNull BiFunction<CommandContext<C>,T,CompletableFuture<O>> mapper)

Create a descriptor for a mapped parser.

Type Parameters:

O - mapped parser result type

Parameters:

mappedType - mapped parser result type

mapper - mapper

Returns:

mapped parser descriptor

mapSuccess

default <O> @NonNull ParserDescriptor<C,O> mapSuccess(@NonNull Class<O> mappedType,
 @NonNull BiFunction<CommandContext<C>,T,CompletableFuture<O>> mapper)

Create a descriptor for a mapped parser.

Type Parameters:

O - mapped parser result type

Parameters:

mappedType - mapped parser result type

mapper - mapper

Returns:

mapped parser descriptor

of

static <C,
T> @NonNull ParserDescriptor<C,T> of(@NonNull ArgumentParser<C,T> parser,
 @NonNull TypeToken<T> valueType)

Creates a new parser descriptor.

Type Parameters:

C - the command sender type

T - the type of values produced by the parser

Parameters:

parser - the parser

valueType - the type of values produced by the parser

Returns:

the created descriptor

of

static <C,
T> @NonNull ParserDescriptor<C,T> of(@NonNull ArgumentParser<C,T> parser,
 @NonNull Class<T> valueType)

Creates a new parser descriptor.

Type Parameters:

C - the command sender type

T - the type of values produced by the parser

Parameters:

parser - the parser

valueType - the type of values produced by the parser

Returns:

the created descriptor

parserDescriptor

static <C,
T> @NonNull ParserDescriptor<C,T> parserDescriptor(@NonNull ArgumentParser<C,T> parser,
 @NonNull TypeToken<T> valueType)

Creates a new parser descriptor.

Type Parameters:

C - the command sender type

T - the type of values produced by the parser

Parameters:

parser - the parser

valueType - the type of values produced by the parser

Returns:

the created descriptor

parserDescriptor

static <C,
T> @NonNull ParserDescriptor<C,T> parserDescriptor(@NonNull ArgumentParser<C,T> parser,
 @NonNull Class<T> valueType)

Creates a new parser descriptor.

Type Parameters:

C - the command sender type

T - the type of values produced by the parser

Parameters:

parser - the parser

valueType - the type of values produced by the parser

Returns:

the created descriptor