Package me.s3ns3iw00.jcommands.argument

Class InputArgument<I,O>

java.lang.Object

me.s3ns3iw00.jcommands.argument.Argument<O>

me.s3ns3iw00.jcommands.argument.InputArgument<I,O>

Type Parameters:

I - the type of input

O - the type of output

Direct Known Subclasses:

AttachmentArgument, AutocompletableInputArgument, ChannelArgument, ComboArgument, MentionArgument, RoleArgument, URLArgument

public abstract class InputArgument<I,O>
extends Argument<O>

Represents argument that can have multiple value depends on the user input and the restrictions of the argument These arguments can be optional

Constructor Summary

Constructors

Constructor	Description
InputArgument(java.lang.String name, java.lang.String description, org.javacord.api.interaction.SlashCommandOptionType type)	Constructs the argument with the default requirements
InputArgument(java.lang.String name, java.lang.String description, org.javacord.api.interaction.SlashCommandOptionType type, java.lang.Class<O> resultType)	Runs the default constructor and specifies the result type of the value, that the input will be converted to

Method Summary

Modifier and Type	Method	Description
void	convertResult(ArgumentResultConverter<I,O> resultConverter)
ArgumentValidator<I>	getArgumentValidator()
org.javacord.api.interaction.SlashCommandOption	getCommandOption()
java.util.Optional<ArgumentResultConverter<I,O>>	getResultConverter()
java.lang.Class<O>	getResultType()
boolean	isOptional()
void	setOptional()

Methods inherited from class me.s3ns3iw00.jcommands.argument.Argument

getDescription, getMismatchListener, getName, getType, setOnMismatch

Methods inherited from class java.lang.Object

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

Constructor Detail

InputArgument

public InputArgument(java.lang.String name,
                     java.lang.String description,
                     org.javacord.api.interaction.SlashCommandOptionType type)

Constructs the argument with the default requirements

Parameters:

name - the argument's name

description - the argument's description

type - the type of the input value

InputArgument

public InputArgument(java.lang.String name,
                     java.lang.String description,
                     org.javacord.api.interaction.SlashCommandOptionType type,
                     java.lang.Class<O> resultType)

Runs the default constructor and specifies the result type of the value, that the input will be converted to

Parameters:

name - the argument's name

description - the argument's description

type - the type of the value

resultType - the type of the converted value

Method Detail

getCommandOption

public org.javacord.api.interaction.SlashCommandOption getCommandOption()

Specified by:

getCommandOption in class Argument<O>

Returns:

the command option that need for to register the argument

isOptional

public boolean isOptional()

setOptional

public void setOptional()

getResultType

public java.lang.Class<O> getResultType()

Specified by:

getResultType in class Argument<O>

Returns:

the class of the result's type

getArgumentValidator

public ArgumentValidator<I> getArgumentValidator()

convertResult

public void convertResult(ArgumentResultConverter<I,O> resultConverter)

getResultConverter

public java.util.Optional<ArgumentResultConverter<I,O>> getResultConverter()