Package dev.sympho.modular_commands.utils.parse

Class ChannelParser<C extends @NonNull Channel>

java.lang.Object

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

dev.sympho.modular_commands.utils.parse.MentionableParser<C>

dev.sympho.modular_commands.utils.parse.ChannelParser<C>

Type Parameters:

C - The channel type.

All Implemented Interfaces:

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

public class ChannelParser<C extends @NonNull Channel>
extends MentionableParser<C>

A parser that extracts a channel 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

Constructor	Description
ChannelParser(Class<C> type)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected Mono<C>	getEntity(CommandContext context, Snowflake id)	Retrieves the entity with the given ID.
@Nullable ChannelUrlParser<C>	getUrlParser()	Retrieves the parser to use for URLs, if supported.
String	parseMention(String mention)	Parses the entity ID from a text mention.

Methods inherited from class dev.sympho.modular_commands.utils.parse.MentionableParser

extractId, parseMention

Methods inherited from class dev.sympho.modular_commands.utils.parse.EntityParser

parse, parseId

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

ChannelParser

@Pure
public ChannelParser(Class<C> type)

Creates a new instance.

Parameters:

type - The type of channel.

Method Details

getUrlParser

public @Nullable ChannelUrlParser<C> getUrlParser()

Description copied from class: EntityParser

Retrieves the parser to use for URLs, if supported.

Overrides:

getUrlParser in class EntityParser<C extends @NonNull Channel>

Returns:

The URL parser, or null if URLs are not supported.

getEntity

protected Mono<C> getEntity(CommandContext context,
 Snowflake id)

Description copied from class: EntityParser

Retrieves the entity with the given ID.

Specified by:

getEntity in class EntityParser<C extends @NonNull Channel>

Parameters:

context - The execution context.

id - The entity ID.

Returns:

The entity. May be empty if not found.

parseMention

public String parseMention(String mention)
                    throws InvalidArgumentException

Description copied from class: MentionableParser

Parses the entity ID from a text mention.

Specified by:

parseMention in class MentionableParser<C extends @NonNull Channel>

Parameters:

mention - The text mention.

Returns:

The ID in the mention.

Throws:

InvalidArgumentException - if the mention was invalid.