org.enginehub.piston.converter

Class SimpleArgumentConverter<T>

java.lang.Object

org.enginehub.piston.converter.SimpleArgumentConverter<T>

All Implemented Interfaces:

ArgumentConverter<T>, Converter<T>, SuggestionProvider

public class SimpleArgumentConverter<T>
extends java.lang.Object
implements ArgumentConverter<T>

A simple base implementation of ArgumentConverter. Provides no suggestions, but you can call withSuggestions(SuggestionProvider) to supply them.

Method Summary

Modifier and Type	Method and Description
ConversionResult<T>	convert(java.lang.String argument, InjectedValueAccess context) Converts the argument input to a collection of argument values.
net.kyori.text.Component	describeAcceptableArguments() Describe the arguments that can be provided to this converter.
static <T> SimpleArgumentConverter<T>	from(Converter<T> converter, net.kyori.text.Component description) Implements Converter.convert(String, InjectedValueAccess) using the provided function, and supplies the provided description for ArgumentConverter.describeAcceptableArguments().
static <T> SimpleArgumentConverter<T>	from(Converter<T> converter, java.lang.String description)
ArgumentConverter<T>	withSuggestions(SuggestionProvider suggestions)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.enginehub.piston.converter.ArgumentConverter

getSuggestions

Method Detail

from

public static <T> SimpleArgumentConverter<T> from(Converter<T> converter,
                                                  java.lang.String description)

from

public static <T> SimpleArgumentConverter<T> from(Converter<T> converter,
                                                  net.kyori.text.Component description)

Implements Converter.convert(String, InjectedValueAccess) using the provided function, and supplies the provided description for ArgumentConverter.describeAcceptableArguments().

Type Parameters:

T - the type of the argument

Parameters:

converter - the converter function

description - the acceptable arguments description

Returns:

a converter using the given function and description

convert

public ConversionResult<T> convert(java.lang.String argument,
                                   InjectedValueAccess context)

Description copied from interface: Converter

Converts the argument input to a collection of argument values.

This method should be pure, i.e. it should not send any error messages to anything in the context. This could result in spurious error messages during parsing.

Specified by:

convert in interface Converter<T>

Parameters:

argument - the argument input to convert

context - the context to convert in

Returns:

the result of attempting to convert the argument

describeAcceptableArguments

public net.kyori.text.Component describeAcceptableArguments()

Description copied from interface: ArgumentConverter

Describe the arguments that can be provided to this converter.

This information is displayed to the user.

Specified by:

describeAcceptableArguments in interface ArgumentConverter<T>

Returns:

a description of acceptable arguments

withSuggestions

public ArgumentConverter<T> withSuggestions(SuggestionProvider suggestions)