Package dev.jorel.commandapi.arguments

Class ListArgumentBuilder.ListArgumentBuilderSuggests

java.lang.Object

dev.jorel.commandapi.arguments.ListArgumentBuilder.ListArgumentBuilderSuggests

Enclosing class:

ListArgumentBuilder<T>

public class ListArgumentBuilder.ListArgumentBuilderSuggests
extends Object

An intermediary class for the ListArgumentBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ListArgumentBuilder.ListArgumentBuilderSuggests.ListArgumentBuilderFinished	An intermediary class for the ListArgumentBuilder

Method Summary

Modifier and Type	Method	Description
ListArgumentBuilder<T>.ListArgumentBuilderSuggests.ListArgumentBuilderFinished	withMapper(Function<T,String> mapper)	Specifies the mapping function of the specific type T to a String so an element can be shown to a user as suggestions.
ListArgumentBuilder<T>.ListArgumentBuilderSuggests.ListArgumentBuilderFinished	withStringMapper()	Specifies that the mapping function for this argument calls the toString() method.
ListArgumentBuilder<T>.ListArgumentBuilderSuggests.ListArgumentBuilderFinished	withStringTooltipMapper(Function<T,IStringTooltip> mapper)	Specifies the mapping function of the specific type T to a IStringTooltip so an element can be shown to a user as a suggestion with a tooltip.

Methods inherited from class java.lang.Object

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

Method Details

withStringMapper

public ListArgumentBuilder<T>.ListArgumentBuilderSuggests.ListArgumentBuilderFinished withStringMapper()

Specifies that the mapping function for this argument calls the toString() method.

Returns:

this list argument builder

withMapper

public ListArgumentBuilder<T>.ListArgumentBuilderSuggests.ListArgumentBuilderFinished withMapper(Function<T,String> mapper)

Specifies the mapping function of the specific type T to a String so an element can be shown to a user as suggestions.

Parameters:

mapper - the mapping function that creates a String

Returns:

this list argument builder

withStringTooltipMapper

public ListArgumentBuilder<T>.ListArgumentBuilderSuggests.ListArgumentBuilderFinished withStringTooltipMapper(Function<T,IStringTooltip> mapper)

Specifies the mapping function of the specific type T to a IStringTooltip so an element can be shown to a user as a suggestion with a tooltip.

Parameters:

mapper - the mapping function that creates an IStringTooltip

Returns:

this list argument builder