com.ericramirezs.commando4j.arguments

Class LocalTimeArgument

java.lang.Object

com.ericramirezs.commando4j.arguments.Argument<A,T>

com.ericramirezs.commando4j.arguments.LocalTimeArgument

All Implemented Interfaces:

IArgument<LocalTimeArgument,LocalTime>

public final class LocalTimeArgument
extends Argument<A,T>

Class to request an argument of type LocalTime to the user.

See Also:

LocalTime

Constructor Summary

Constructors

Constructor and Description
LocalTimeArgument(@NotNull String name, @NotNull String prompt) Creates an instance of this Argument implementation

Method Summary

Modifier and Type	Method and Description
LocalTimeArgument	clone() An argument clone is required to prevent a value traveling through different Command calls.
boolean	isForcedDiscordTag() Checks if the user must use Discord's time tag syntax for this argument.
LocalTime	parse(net.dv8tion.jda.api.events.message.MessageReceivedEvent event, String arg) To be called if all validations passed.
LocalTime	parse(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, String arg) To be called if all validations passed.
A	setForcedTag() Set if the user must use Discord's time tag syntax for this argument.
String	validate(net.dv8tion.jda.api.events.message.MessageReceivedEvent event, String arg) Validates if the argument input by the user is a valid value.
String	validate(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event, String arg) Validates if the argument input by the user is a valid value.

Methods inherited from class com.ericramirezs.commando4j.arguments.Argument

addValidValues, clone, getDefaultValue, getMax, getMin, getName, getPrompt, getPrompt, getPromptRaw, getType, getValidValues, getValue, inRange, inRange, inRange, inRange, inRange, inRange, isRequired, oneOf, setDefaultValue, setDefaultValue, setMax, setMax, setMax, setMax, setMin, setMin, setMin, setMin, setPromptParser, setRequired, setSlashValue, setValue, validateNull

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalTimeArgument

public LocalTimeArgument(@NotNull
                         @NotNull String name,
                         @NotNull
                         @NotNull String prompt)

Creates an instance of this Argument implementation

Parameters:

name - Readable name to display to the final

prompt - Hint to indicate the user the expected value to be passed to this argument.

Method Detail

validate

public String validate(net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                       String arg)

Description copied from interface: IArgument

Validates if the argument input by the user is a valid value. This method validates any possible problem with the value input by the user.

Parameters:

event - Discord event that triggered this function call.

arg - argument input by the user.

Returns:

null if no argument is valid, Error message if the argument has a problem to parse it.

validate

public String validate(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                       String arg)

Description copied from interface: IArgument

Validates if the argument input by the user is a valid value. This method validates any possible problem with the value input by the user.

Parameters:

event - Discord event that triggered this function call.

arg - argument input by the user.

Returns:

null if no argument is valid, Error message if the argument has a problem to parse it.

parse

public LocalTime parse(net.dv8tion.jda.api.events.message.MessageReceivedEvent event,
                       String arg)

Description copied from interface: IArgument

To be called if all validations passed. Convert's the input String argument into the expected final object.

Parameters:

event - Discord event that triggered this function call.

arg - argument input by the user.

Returns:

parsed argument.

See Also:

IArgument.validate(MessageReceivedEvent, String)

parse

public LocalTime parse(net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent event,
                       String arg)

Description copied from interface: IArgument

To be called if all validations passed. Convert's the input String argument into the expected final object.

Parameters:

event - Discord event that triggered this function call.

arg - argument input by the user.

Returns:

parsed argument.

See Also:

IArgument.validate(MessageReceivedEvent, String)

clone

public LocalTimeArgument clone()

Description copied from class: Argument

An argument clone is required to prevent a value traveling through different Command calls.

If your Argument child doesn't have additional attribute, you may just do return clone(new MyArgument(getName(), getPrompt()));

Specified by:

clone in interface IArgument<LocalTimeArgument,LocalTime>

Returns:

a clone of this instance.

setForcedTag

public A setForcedTag()

Set if the user must use Discord's time tag syntax for this argument.

Visit message-formatting-formats for more information about Discord's time tag syntax.

Returns:

a reference to this object.

isForcedDiscordTag

public boolean isForcedDiscordTag()

Checks if the user must use Discord's time tag syntax for this argument.

Visit message-formatting-formats for more information about Discord's time tag syntax.

Returns:

true if the argument only accepts discord's time tag.