Package dev.sympho.modular_commands.utils.parse

Class ChannelUrlParser<C extends @NonNull Channel>

java.lang.Object

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

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

Type Parameters:

C - The channel type.

All Implemented Interfaces:

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

public class ChannelUrlParser<C extends @NonNull Channel>
extends EntityUrlParser<C>

A parser for channel URLs.

Since:

1.0

Version:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface dev.sympho.modular_commands.utils.parse.UrlParser

UrlParser.Choice<T extends @NonNull Object>, UrlParser.ChoiceBase<T extends @NonNull Object,P extends UrlParser<T>>, UrlParser.PostParser<I extends @NonNull Object,T extends @NonNull Object,P1 extends @NonNull UrlParser<I>,P2 extends @NonNull ParserFunction<I,T>>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected @Nullable Mono<C>	parsePath(GatewayDiscordClient client, String path)	Parses the URL path.
String	typeName()	Gets the display name for this type.
static <C extends @NonNull Channel> C	validate(Channel channel, Class<C> type)	Validates that a channel is of the given type.
protected boolean	validPath(String path)	Checks if the given path (endpoint) is valid for the entity type of this parser.

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

parse, supports

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

Methods inherited from interface dev.sympho.modular_commands.utils.parse.UrlParser

parse, then

Constructor Details

ChannelUrlParser

@Pure
public ChannelUrlParser(Class<C> type)

Creates a new instance.

Parameters:

type - The type of channel.

Method Details

validate

@Pure
public static <C extends @NonNull Channel> C validate(Channel channel,
 Class<C> type)
                                               throws InvalidArgumentException

Validates that a channel is of the given type.

Type Parameters:

C - The channel type.

Parameters:

channel - The channel.

type - The channel type.

Returns:

The channel.

Throws:

InvalidArgumentException - if the channel does not match the given type.

typeName

public String typeName()

Description copied from class: EntityUrlParser

Gets the display name for this type.

Specified by:

typeName in class EntityUrlParser<C extends @NonNull Channel>

Returns:

The name.

validPath

protected boolean validPath(String path)

Description copied from class: EntityUrlParser

Checks if the given path (endpoint) is valid for the entity type of this parser.

Specified by:

validPath in class EntityUrlParser<C extends @NonNull Channel>

Parameters:

path - The path.

Returns:

If the path is valid for this parser.

parsePath

protected @Nullable Mono<C> parsePath(GatewayDiscordClient client,
 String path)

Description copied from class: EntityUrlParser

Parses the URL path.

Specified by:

parsePath in class EntityUrlParser<C extends @NonNull Channel>

Parameters:

client - The Discord client.

path - The path.

Returns:

The parsed entity, or null if the path is not valid.