Package dev.jorel.commandapi.arguments

Class MapArgumentBuilder<K,V>

java.lang.Object

dev.jorel.commandapi.arguments.MapArgumentBuilder<K,V>

Type Parameters:

K - The type of keys this map should contain

V - The type of values this map should contain

public class MapArgumentBuilder<K,V>
extends Object

A builder to create a MapArgument

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	MapArgumentBuilder.MapArgumentBuilderValueMapper	An intermediary class for the MapArgumentBuilder

Constructor Summary

Constructors

Constructor	Description
MapArgumentBuilder(String nodeName)	Creates a new MapArgumentBuilder with a specified node name.
MapArgumentBuilder(String nodeName, char delimiter)	Creates a new MapArgumentBuilder with a specified node name
MapArgumentBuilder(String nodeName, char delimiter, String separator)	Creates a new MapArgumentBuilder with a specified node name

Method Summary

Modifier and Type	Method	Description
MapArgumentBuilder<K,V>.MapArgumentBuilderValueMapper	withKeyMapper(StringParser<K> keyMapper)	This starts the builder for the MapArgument

Methods inherited from class java.lang.Object

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

Constructor Details

MapArgumentBuilder

public MapArgumentBuilder(String nodeName)

Creates a new MapArgumentBuilder with a specified node name. Defaults the delimiter for each key/value pair to a colon

Parameters:

nodeName - the name of the node for this argument

MapArgumentBuilder

public MapArgumentBuilder(String nodeName,
 char delimiter)

Creates a new MapArgumentBuilder with a specified node name

Parameters:

nodeName - the name of the node for this argument

delimiter - the separator for each key/value pair

MapArgumentBuilder

public MapArgumentBuilder(String nodeName,
 char delimiter,
 String separator)

Creates a new MapArgumentBuilder with a specified node name

Parameters:

nodeName - the name of the node for this argument

delimiter - the separator for each key/value pair

separator - the separator between a key and a value

Method Details

withKeyMapper

public MapArgumentBuilder<K,V>.MapArgumentBuilderValueMapper withKeyMapper(StringParser<K> keyMapper)

This starts the builder for the MapArgument

Returns:

this map argument builder