Package cloud.commandframework.bukkit.parsers

Class BlockPredicateArgument<C>

java.lang.Object

cloud.commandframework.arguments.CommandArgument<C,BlockPredicate>

cloud.commandframework.bukkit.parsers.BlockPredicateArgument<C>

Type Parameters:

C - Command sender type

All Implemented Interfaces:

cloud.commandframework.keys.CloudKeyHolder<BlockPredicate>, Comparable<cloud.commandframework.arguments.CommandArgument<?,?>>

public final class BlockPredicateArgument<C>
extends cloud.commandframework.arguments.CommandArgument<C,BlockPredicate>

Argument type for parsing a BlockPredicate.

This argument type is only usable on Minecraft 1.13+, as it depends on Minecraft internals added in that version.

This argument type only provides basic suggestions by default. Enabling Brigadier compatibility through BukkitCommandManager.registerBrigadier() will allow client side validation and suggestions to be utilized.

Since:

1.5.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BlockPredicateArgument.Builder<C>	Builder for BlockPredicateArgument.
static final class	BlockPredicateArgument.Parser<C>	Parser for BlockPredicateArgument.

Nested classes/interfaces inherited from class cloud.commandframework.arguments.CommandArgument

cloud.commandframework.arguments.CommandArgument.TypedBuilder<C extends Object,T extends Object,B extends cloud.commandframework.arguments.CommandArgument.Builder<C,T>>

Method Summary

Modifier and Type	Method	Description
static <C> @NonNull BlockPredicateArgument.Builder<C>	builder(@NonNull String name)	Create a new BlockPredicateArgument.Builder.
static <C> @NonNull BlockPredicateArgument<C>	of(@NonNull String name)	Create a new required BlockPredicateArgument.
static <C> @NonNull BlockPredicateArgument<C>	optional(@NonNull String name)	Create a new optional BlockPredicateArgument.

Methods inherited from class cloud.commandframework.arguments.CommandArgument

addPreprocessor, compareTo, copy, equals, getDefaultDescription, getDefaultValue, getKey, getName, getOwningCommand, getParser, getSuggestionsProvider, getValueType, hasDefaultValue, hashCode, isArgumentRegistered, isRequired, ofType, ofType, preprocess, setArgumentRegistered, setOwningCommand, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

builder

public static <C>
@NonNull BlockPredicateArgument.Builder<C> builder(@NonNull String name)

Create a new BlockPredicateArgument.Builder.

Type Parameters:

C - Command sender type

Parameters:

name - Name of the argument

Returns:

Created builder

Since:

1.5.0

of

public static <C>
@NonNull BlockPredicateArgument<C> of(@NonNull String name)

Create a new required BlockPredicateArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

Since:

1.5.0

optional

public static <C>
@NonNull BlockPredicateArgument<C> optional(@NonNull String name)

Create a new optional BlockPredicateArgument.

Type Parameters:

C - Command sender type

Parameters:

name - Argument name

Returns:

Created argument

Since:

1.5.0