Package dev.efekos.arn.resolver.impl.command

Class CmdEnumArg

java.lang.Object

dev.efekos.arn.resolver.impl.command.CmdEnumArg

All Implemented Interfaces:

CommandArgumentResolver

public final class CmdEnumArg
extends Object
implements CommandArgumentResolver

An implementation of CommandArgumentResolver. Resolves custom Enum arguments that is annotated with CustomArgument.

Since:

0.1

Author:

efekos

Field Summary

Fields

Modifier and Type	Field	Description
private final List<String>	constants	Constants of enumClass in lower-case.
private final Class<? extends Enum<?>>	enumClass	Main Enum class this resolver will handle.

Constructor Summary

Constructors

Constructor	Description
CmdEnumArg(Class<? extends Enum<?>> enumClass)	Creates a new enumerator resolver.

Method Summary

Modifier and Type	Method	Description
com.mojang.brigadier.builder.ArgumentBuilder	apply(Parameter parameter)	Creates a ArgumentBuilder that will represent parameter in the command structure.
boolean	isApplicable(Parameter parameter)	Returns whether this CommandArgumentResolver can resolve parameter.

Methods inherited from class java.lang.Object

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

Field Details

enumClass

private final Class<? extends Enum<?>> enumClass

Main Enum class this resolver will handle.

constants

private final List<String> constants

Constants of enumClass in lower-case.

Constructor Details

CmdEnumArg

public CmdEnumArg(Class<? extends Enum<?>> enumClass)

Creates a new enumerator resolver. This class is not a static argument resolver. It is dynamically added by Arn for every Enum that is annotated with CustomArgument.

Parameters:

enumClass - Main Enum class this resolver will handle.

Method Details

isApplicable

public boolean isApplicable(Parameter parameter)

Returns whether this CommandArgumentResolver can resolve parameter. Keep in mind that there shouldn't be more than one CommandArgumentResolver that can resolver the same parameter.

Specified by:

isApplicable in interface CommandArgumentResolver

Parameters:

parameter - A parameter of a CommandHandlerMethod.

Returns:

true if this Parameter should be resolved using this CommandArgumentResolver, false otherwise.

apply

public com.mojang.brigadier.builder.ArgumentBuilder apply(Parameter parameter)

Creates a ArgumentBuilder that will represent parameter in the command structure.

Specified by:

apply in interface CommandArgumentResolver

Parameters:

parameter - A parameter of a CommandHandlerMethod.

Returns:

An ArgumentBuilder that represents parameter.