Package dev.sympho.modular_commands.utils.parse.entity

Class EntityParser<E extends @NonNull Entity>

java.lang.Object

dev.sympho.modular_commands.utils.parse.entity.EntityParser<E>

Type Parameters:

E - The entity type.

All Implemented Interfaces:

ParserFunction<String,E>, BiFunction<CommandContext,String,Mono<E>>

Direct Known Subclasses:

ChannelParser, MessageParser, RoleParser, UserParser

public abstract class EntityParser<E extends @NonNull Entity>
extends Object
implements ParserFunction<String,E>

A parser that extracts an entity from a string.

Since:

1.0

Version:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface dev.sympho.modular_commands.api.command.parameter.parse.ParserFunction

ParserFunction.PostParser<R extends @NonNull Object,I extends @NonNull Object,T extends @NonNull Object,P1 extends @NonNull ParserFunction<R,I>,P2 extends @NonNull ParserFunction<I,T>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EntityParser(EntityRefParser<? extends EntityRef<E>> parser)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
Mono<E>	parse(CommandContext context, String raw)	Parses the given raw argument from the user into the corresponding value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface dev.sympho.modular_commands.api.command.parameter.parse.ParserFunction

apply, then

Constructor Details

EntityParser

protected EntityParser(EntityRefParser<? extends EntityRef<E>> parser)

Creates a new instance.

Parameters:

parser - The parser to delegate to.

Method Details

parse

public Mono<E> parse(CommandContext context,
 String raw)
              throws InvalidArgumentException

Description copied from interface: ParserFunction

Parses the given raw argument from the user into the corresponding value.

Specified by:

parse in interface ParserFunction<String,E extends @NonNull Entity>

Parameters:

context - The execution context.

raw - The raw argument received from the user.

Returns:

A Mono that issues the parsed argument. If the raw value is invalid, it may fail with a InvalidArgumentException. May be empty, in which case the value defers to the default (functionally the same as if the argument was missing, but without causing an error if the parameter is required).

Throws:

InvalidArgumentException - if the given argument is not a valid value.