CommandAPI 9.5.2
An API for the command UI introduced in Minecraft 1.13
dev.jorel.commandapi.arguments.MapArgumentBuilder< K, V > Class Template Reference

A builder to create a MapArgument. More...

Classes

class  MapArgumentBuilderValueMapper
 An intermediary class for the MapArgumentBuilder. More...
 

Public Member Functions

 MapArgumentBuilder (String nodeName)
 Creates a new MapArgumentBuilder with a specified node name. More...
 
 MapArgumentBuilder (String nodeName, char delimiter)
 Creates a new MapArgumentBuilder with a specified node name. More...
 
 MapArgumentBuilder (String nodeName, char delimiter, String separator)
 Creates a new MapArgumentBuilder with a specified node name. More...
 
MapArgumentBuilderValueMapper withKeyMapper (StringParser< K > keyMapper)
 This starts the builder for the MapArgument. More...
 

Detailed Description

A builder to create a MapArgument.

Parameters
<K>The type of keys this map should contain
<V>The type of values this map should contain

Constructor & Destructor Documentation

◆ MapArgumentBuilder() [1/3]

Creates a new MapArgumentBuilder with a specified node name.

Defaults the delimiter for each key/value pair to a colon

Parameters
nodeNamethe name of the node for this argument

◆ MapArgumentBuilder() [2/3]

dev.jorel.commandapi.arguments.MapArgumentBuilder< K, V >.MapArgumentBuilder ( String  nodeName,
char  delimiter 
)

Creates a new MapArgumentBuilder with a specified node name.

Parameters
nodeNamethe name of the node for this argument
delimiterthe separator for each key/value pair

◆ MapArgumentBuilder() [3/3]

dev.jorel.commandapi.arguments.MapArgumentBuilder< K, V >.MapArgumentBuilder ( String  nodeName,
char  delimiter,
String  separator 
)

Creates a new MapArgumentBuilder with a specified node name.

Parameters
nodeNamethe name of the node for this argument
delimiterthe separator for each key/value pair
separatorthe separator between a key and a value

Member Function Documentation

◆ withKeyMapper()

This starts the builder for the MapArgument.

Returns
this map argument builder