Package cloud.commandframework.arguments.compound

Class CompoundArgument<T extends Tuple,C,O>

java.lang.Object

cloud.commandframework.arguments.CommandArgument<C,O>

cloud.commandframework.arguments.compound.CompoundArgument<T,C,O>

Type Parameters:

T - Tuple type

C - Command sender type

O - Output type

All Implemented Interfaces:

CloudKeyHolder<O>, Comparable<CommandArgument<?,?>>

Direct Known Subclasses:

ArgumentPair, ArgumentTriplet

@API(status=STABLE)
public class CompoundArgument<T extends Tuple,C,O>
extends CommandArgument<C,O>

Compound argument

Nested Class Summary

Nested classes/interfaces inherited from class cloud.commandframework.arguments.CommandArgument

CommandArgument.Builder<C,T>, CommandArgument.TypedBuilder<C,T,B extends CommandArgument.Builder<C,T>>

Constructor Summary

Constructors

Constructor	Description
CompoundArgument(boolean required, @NonNull String name, @NonNull Tuple names, @NonNull Tuple parserTuple, @NonNull Tuple types, @NonNull BiFunction<@NonNull C,@NonNull T,@NonNull O> mapper, @NonNull Function<@NonNull Object[],@NonNull T> tupleFactory, @NonNull io.leangen.geantyref.TypeToken<O> valueType)	Construct a Compound Argument

Method Summary

Modifier and Type	Method	Description
@NonNull Tuple	getNames()	Get the argument names
@NonNull Tuple	getParserTuple()	Get the tuple containing the internal parsers
@NonNull Tuple	getTypes()	Get the parser types

Methods inherited from class cloud.commandframework.arguments.CommandArgument

addPreprocessor, compareTo, copy, equals, getDefaultDescription, getDefaultValue, getKey, getName, getOwningCommand, getParser, getSuggestionsProvider, getValueType, hasDefaultValue, hashCode, isArgumentRegistered, isRequired, ofType, ofType, preprocess, setArgumentRegistered, setOwningCommand, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CompoundArgument

public CompoundArgument(boolean required,
 @NonNull String name,
 @NonNull Tuple names,
 @NonNull Tuple parserTuple,
 @NonNull Tuple types,
 @NonNull BiFunction<@NonNull C,@NonNull T,@NonNull O> mapper,
 @NonNull Function<@NonNull Object[],@NonNull T> tupleFactory,
 @NonNull io.leangen.geantyref.TypeToken<O> valueType)

Construct a Compound Argument

Parameters:

required - Whether or not the argument is required

name - The argument name

names - Names of the sub-arguments (in order)

parserTuple - The sub arguments

types - Types of the sub-arguments (in order)

mapper - Mapper that maps the sub-arguments to the output type

tupleFactory - Function to use when creating tuple

valueType - The output type

Method Details

getParserTuple

public @NonNull Tuple getParserTuple()

Get the tuple containing the internal parsers

Returns:

Internal parsers

getNames

public @NonNull Tuple getNames()

Get the argument names

Returns:

Argument names

getTypes

public @NonNull Tuple getTypes()

Get the parser types

Returns:

Parser types