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

Class ChannelRefUrlParser<C extends @NonNull Channel>

java.lang.Object

dev.sympho.modular_commands.utils.parse.entity.EntityRefUrlParser<EntityRef.ChannelRef<C>>

dev.sympho.modular_commands.utils.parse.entity.ChannelRefUrlParser<C>

Type Parameters:

C - The channel type.

All Implemented Interfaces:

ParserFunction<String,EntityRef.ChannelRef<C>>, UrlParser<EntityRef.ChannelRef<C>>, BiFunction<CommandContext,String,Mono<EntityRef.ChannelRef<C>>>

public class ChannelRefUrlParser<C extends @NonNull Channel>
extends EntityRefUrlParser<EntityRef.ChannelRef<C>>

A reference 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
ChannelRefUrlParser(Class<C> type)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected @Nullable EntityRef.ChannelRef<C>	parsePath(String path)	Parses the URL path.
String	typeName()	Gets the display name for this 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.entity.EntityRefUrlParser

parse, parse, 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

ChannelRefUrlParser

@Pure
public ChannelRefUrlParser(Class<C> type)

Creates a new instance.

Parameters:

type - The type of channel.

Method Details

typeName

public String typeName()

Description copied from class: EntityRefUrlParser

Gets the display name for this type.

Specified by:

typeName in class EntityRefUrlParser<EntityRef.ChannelRef<C extends @NonNull Channel>>

Returns:

The name.

validPath

protected boolean validPath(String path)

Description copied from class: EntityRefUrlParser

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

Specified by:

validPath in class EntityRefUrlParser<EntityRef.ChannelRef<C extends @NonNull Channel>>

Parameters:

path - The path.

Returns:

If the path is valid for this parser.

parsePath

protected @Nullable EntityRef.ChannelRef<C> parsePath(String path)

Description copied from class: EntityRefUrlParser

Parses the URL path.

Specified by:

parsePath in class EntityRefUrlParser<EntityRef.ChannelRef<C extends @NonNull Channel>>

Parameters:

path - The path.

Returns:

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