Package org.incendo.cloud.parser.aggregate

Class AggregateParserPairBuilder<C,U,V,O>

java.lang.Object

org.incendo.cloud.parser.aggregate.AggregateParserPairBuilder<C,U,V,O>

public final class AggregateParserPairBuilder<C,U,V,O>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AggregateParserPairBuilder.Mapper<C,U,V,O>

Constructor Summary

Constructors

Constructor	Description
AggregateParserPairBuilder(TypedCommandComponent<C,U> first, TypedCommandComponent<C,V> second, AggregateParserPairBuilder.Mapper<C,U,V,O> mapper, TypeToken<O> outType)	Creates a new AggregateParserPairBuilder with the given components and mapper.

Method Summary

Modifier and Type	Method	Description
AggregateParser<C,O>	build()	Builds an AggregateParser from the current state of the builder.
static <C, U, V> AggregateParserPairBuilder.Mapper<C,U,V,Pair<U,V>>	defaultMapper()	Creates the default mapper that simply returns a Pair of the two input values.
static <C, U, V, O> @NonNull AggregateParserPairBuilder.Mapper<C,U,V,O>	directMapper(@NonNull AggregateParserPairBuilder.Mapper.DirectSuccessMapper<C,U,V,O> mapper)	Helper function to create a direct success mapper.
<O1> AggregateParserPairBuilder<C,U,V,O1>	withDirectMapper(@NonNull TypeToken<O1> outType, @NonNull AggregateParserPairBuilder.Mapper.DirectSuccessMapper<C,U,V,O1> mapper)	Creates a new AggregateParserPairBuilder with the given mapper.
<O1> AggregateParserPairBuilder<C,U,V,O1>	withMapper(@NonNull TypeToken<O1> outType, @NonNull AggregateParserPairBuilder.Mapper<C,U,V,O1> mapper)	Creates a new AggregateParserPairBuilder with the given mapper.

Methods inherited from class java.lang.Object

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

Constructor Details

AggregateParserPairBuilder

public AggregateParserPairBuilder(TypedCommandComponent<C,U> first,
 TypedCommandComponent<C,V> second,
 AggregateParserPairBuilder.Mapper<C,U,V,O> mapper,
 TypeToken<O> outType)

Creates a new AggregateParserPairBuilder with the given components and mapper.

Parameters:

first - the first component

second - the second component

mapper - the mapper

outType - the output type

Method Details

defaultMapper

public static <C,
U,
V>
AggregateParserPairBuilder.Mapper<C,U,V,Pair<U,V>> defaultMapper()

Creates the default mapper that simply returns a Pair of the two input values.

Type Parameters:

C - the command sender type

U - the first type

V - the second type

Returns:

a default mapper that returns a Pair of the two input values

withMapper

public <O1> AggregateParserPairBuilder<C,U,V,O1> withMapper(@NonNull TypeToken<O1> outType,
 @NonNull AggregateParserPairBuilder.Mapper<C,U,V,O1> mapper)

Creates a new AggregateParserPairBuilder with the given mapper.

Type Parameters:

O1 - the new output type

Parameters:

outType - the new output type

mapper - the mapper

Returns:

a new AggregateParserPairBuilder with the given mapper

withDirectMapper

public <O1> AggregateParserPairBuilder<C,U,V,O1> withDirectMapper(@NonNull TypeToken<O1> outType,
 @NonNull AggregateParserPairBuilder.Mapper.DirectSuccessMapper<C,U,V,O1> mapper)

Creates a new AggregateParserPairBuilder with the given mapper.

Type Parameters:

O1 - the new output type

Parameters:

outType - the new output type

mapper - the mapper

Returns:

a new AggregateParserPairBuilder with the given mapper

build

public AggregateParser<C,O> build()

Builds an AggregateParser from the current state of the builder.

Returns:

the built AggregateParser

directMapper

public static <C,
U,
V,
O>
@NonNull AggregateParserPairBuilder.Mapper<C,U,V,O> directMapper(@NonNull AggregateParserPairBuilder.Mapper.DirectSuccessMapper<C,U,V,O> mapper)

Helper function to create a direct success mapper.

Type Parameters:

C - command sender type

U - first component type

V - second component type

O - output type

Parameters:

mapper - mapper

Returns:

mapper