net.darkhax.gamestages.command

Class StageArgumentType

java.lang.Object

net.darkhax.gamestages.command.StageArgumentType

All Implemented Interfaces:

com.mojang.brigadier.arguments.ArgumentType<java.lang.String>

public class StageArgumentType
extends java.lang.Object
implements com.mojang.brigadier.arguments.ArgumentType<java.lang.String>

A command argument type that represents a stage string. Has built in suggestions for all the known stages.

Field Summary

Fields

Modifier and Type	Field and Description
static StageArgumentType	INSTACE An instance of this argument type.

Constructor Summary

Constructors

Constructor and Description
StageArgumentType()

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getExamples()
static java.lang.String	getStage(com.mojang.brigadier.context.CommandContext<?> context, java.lang.String name) Gets a stage name from a command context.
<S> java.util.concurrent.CompletableFuture<com.mojang.brigadier.suggestion.Suggestions>	listSuggestions(com.mojang.brigadier.context.CommandContext<S> context, com.mojang.brigadier.suggestion.SuggestionsBuilder builder)
java.lang.String	parse(com.mojang.brigadier.StringReader reader)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

INSTACE

public static final StageArgumentType INSTACE

An instance of this argument type.

Constructor Detail

StageArgumentType

public StageArgumentType()

Method Detail

getStage

public static java.lang.String getStage(com.mojang.brigadier.context.CommandContext<?> context,
                                        java.lang.String name)

Gets a stage name from a command context.

Parameters:

context - The context.

name - The name of the parameter/argument.

Returns:

The value for this argument.

parse

public java.lang.String parse(com.mojang.brigadier.StringReader reader)
                       throws com.mojang.brigadier.exceptions.CommandSyntaxException

Specified by:

parse in interface com.mojang.brigadier.arguments.ArgumentType<java.lang.String>

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getExamples

public java.util.Collection<java.lang.String> getExamples()

Specified by:

getExamples in interface com.mojang.brigadier.arguments.ArgumentType<java.lang.String>

listSuggestions

public <S> java.util.concurrent.CompletableFuture<com.mojang.brigadier.suggestion.Suggestions> listSuggestions(com.mojang.brigadier.context.CommandContext<S> context,
                                                                                                               com.mojang.brigadier.suggestion.SuggestionsBuilder builder)

Specified by:

listSuggestions in interface com.mojang.brigadier.arguments.ArgumentType<java.lang.String>