Package dev.sympho.modular_commands.utils.parse

Interface RawParser<R extends @NonNull Object>

Type Parameters:

R - The raw type.

All Superinterfaces:

Function<String,Mono<R>>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface RawParser<R extends @NonNull Object>
extends Function<String,Mono<R>>

Parser function that converts a string into one of the supported raw types.

Since:

1.0

Version:

1.0

API Note:

You would normally never need to manually implement this, as this interface already provides parsers for all the supported types through constants and static methods.

Field Summary

Fields

Modifier and Type	Field	Description
static final RawParser<Boolean>	BOOLEAN	Parser for booleans.
static final RawParser<Double>	FLOAT	Parser for floats.
static final RawParser<Long>	INTEGER	Parser for integers.
static final RawParser<Snowflake>	SNOWFLAKE	Parser for snowflakes.
static final RawParser<String>	STRING	Parser for strings.

Method Summary

Modifier and Type	Method	Description
default Mono<R>	apply(String raw)
static <C extends @NonNull Channel> RawParser<C>	channel(CommandContext context, Class<C> type)	Creates a parser for channels with the given context.
static RawParser<Snowflake>	channelId(CommandContext context)	Creates a parser for channel IDs with the given context.
static RawParser<Message>	message(CommandContext context)	Creates a parser for messages with the given context.
static RawParser<Snowflake>	messageId(CommandContext context)	Creates a parser for message IDs with the given context.
Mono<R>	parse(String raw)	Parses the given string into a raw value.
static RawParser<Role>	role(CommandContext context)	Creates a parser for roles with the given context.
static RawParser<Snowflake>	roleId(CommandContext context)	Creates a parser for role IDs with the given context.
static RawParser<User>	user(CommandContext context)	Creates a parser for users with the given context.
static RawParser<Snowflake>	userId(CommandContext context)	Creates a parser for user IDs with the given context.

Methods inherited from interface java.util.function.Function

andThen, compose

Field Details

STRING

static final RawParser<String> STRING

Parser for strings.

API Note:

This is a trivial parser, but it exists for consistency reasons.

BOOLEAN

static final RawParser<Boolean> BOOLEAN

Parser for booleans.

INTEGER

static final RawParser<Long> INTEGER

Parser for integers.

FLOAT

static final RawParser<Double> FLOAT

Parser for floats.

SNOWFLAKE

static final RawParser<Snowflake> SNOWFLAKE

Parser for snowflakes.

Method Details

message

@SideEffectFree
static RawParser<Message> message(CommandContext context)

Creates a parser for messages with the given context.

Parameters:

context - The context to use.

Returns:

The parser.

user

@SideEffectFree
static RawParser<User> user(CommandContext context)

Creates a parser for users with the given context.

Parameters:

context - The context to use.

Returns:

The parser.

role

@SideEffectFree
static RawParser<Role> role(CommandContext context)

Creates a parser for roles with the given context.

Parameters:

context - The context to use.

Returns:

The parser.

channel

@SideEffectFree
static <C extends @NonNull Channel> RawParser<C> channel(CommandContext context,
 Class<C> type)

Creates a parser for channels with the given context.

Type Parameters:

C - The channel type.

Parameters:

context - The context to use.

type - The channel type.

Returns:

The parser.

messageId

@SideEffectFree
static RawParser<Snowflake> messageId(CommandContext context)

Creates a parser for message IDs with the given context.

Parameters:

context - The context to use.

Returns:

The parser.

userId

@SideEffectFree
static RawParser<Snowflake> userId(CommandContext context)

Creates a parser for user IDs with the given context.

Parameters:

context - The context to use.

Returns:

The parser.

roleId

@SideEffectFree
static RawParser<Snowflake> roleId(CommandContext context)

Creates a parser for role IDs with the given context.

Parameters:

context - The context to use.

Returns:

The parser.

channelId

@SideEffectFree
static RawParser<Snowflake> channelId(CommandContext context)

Creates a parser for channel IDs with the given context.

Parameters:

context - The context to use.

Returns:

The parser.

parse

@SideEffectFree
Mono<R> parse(String raw)

Parses the given string into a raw value.

Parameters:

raw - The original string.

Returns:

The pre-parsed raw value. May fail with a InvalidArgumentException if the received value is invalid.

apply

@SideEffectFree
default Mono<R> apply(String raw)

Specified by:

apply in interface Function<String,Mono<R extends @NonNull Object>>