Package org.incendo.cloud.bukkit.parser.location

Class Location2DParser<C>

java.lang.Object

org.incendo.cloud.bukkit.parser.location.Location2DParser<C>

Type Parameters:

C - Command sender type

All Implemented Interfaces:

ArgumentParser<C,Location2D>, BlockingSuggestionProvider<C>, BlockingSuggestionProvider.Strings<C>, SuggestionProvider<C>, SuggestionProviderHolder<C>

public final class Location2DParser<C>
extends Object
implements ArgumentParser<C,Location2D>, BlockingSuggestionProvider.Strings<C>

Parser that parses Location2D from two doubles. This will use the command senders world when it exists, or else it'll use the first loaded Bukkit world

Since:

1.4.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.incendo.cloud.parser.ArgumentParser

ArgumentParser.FutureArgumentParser<C,T>

Nested classes/interfaces inherited from interface org.incendo.cloud.suggestion.BlockingSuggestionProvider

BlockingSuggestionProvider.Strings<C>

Constructor Summary

Constructors

Constructor	Description
Location2DParser()

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull CommandComponent.Builder<C,Location2D>	location2DComponent()	Returns a CommandComponent.Builder using location2DParser() as the parser.
static <C> @NonNull ParserDescriptor<C,Location2D>	location2DParser()	Creates a new location 2D parser.
@NonNull ArgumentParseResult<@NonNull Location2D>	parse(@NonNull CommandContext<@NonNull C> commandContext, @NonNull CommandInput commandInput)
@NonNull Iterable<@NonNull String>	stringSuggestions(@NonNull CommandContext<C> commandContext, @NonNull CommandInput input)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.incendo.cloud.parser.ArgumentParser

flatMap, flatMapSuccess, mapSuccess, parseFuture, suggestionProvider

Methods inherited from interface org.incendo.cloud.suggestion.BlockingSuggestionProvider

suggestionsFuture

Methods inherited from interface org.incendo.cloud.suggestion.BlockingSuggestionProvider.Strings

suggestions

Constructor Details

Location2DParser

public Location2DParser()

Method Details

location2DParser

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull ParserDescriptor<C,Location2D> location2DParser()

Creates a new location 2D parser.

Type Parameters:

C - command sender type

Returns:

the created parser

Since:

2.0.0

location2DComponent

@API(status=STABLE,
     since="2.0.0")
public static <C>
@NonNull CommandComponent.Builder<C,Location2D> location2DComponent()

Returns a CommandComponent.Builder using location2DParser() as the parser.

Type Parameters:

C - the command sender type

Returns:

the component builder

Since:

2.0.0

parse

public @NonNull ArgumentParseResult<@NonNull Location2D> parse(@NonNull CommandContext<@NonNull C> commandContext,
 @NonNull CommandInput commandInput)

Specified by:

parse in interface ArgumentParser<C,Location2D>

stringSuggestions

public @NonNull Iterable<@NonNull String> stringSuggestions(@NonNull CommandContext<C> commandContext,
 @NonNull CommandInput input)

Specified by:

stringSuggestions in interface BlockingSuggestionProvider.Strings<C>