revxrsal.commands.parameter.primitives

Class FloatParameterType

java.lang.Object

revxrsal.commands.parameter.primitives.FloatParameterType

All Implemented Interfaces:

BaseParameterType, ParameterType<CommandActor,java.lang.Float>

public final class FloatParameterType
extends java.lang.Object
implements ParameterType<CommandActor,java.lang.Float>

A basic ParameterType for parsing float types

Nested Class Summary

Nested classes/interfaces inherited from interface revxrsal.commands.parameter.ParameterType

ParameterType.Factory<A extends CommandActor>

Constructor Summary

Constructors

Constructor and Description
FloatParameterType()

Method Summary

Modifier and Type	Method and Description
java.lang.Float	parse(@NotNull MutableStringStream input, @NotNull ExecutionContext<CommandActor> context) Reads input from the given MutableStringStream, parses the object, or throws exceptions if needed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface revxrsal.commands.parameter.ParameterType

defaultSuggestions, isGreedy, parsePriority

Constructor Detail

FloatParameterType

public FloatParameterType()

Method Detail

parse

public java.lang.Float parse(@NotNull
                             @NotNull MutableStringStream input,
                             @NotNull
                             @NotNull ExecutionContext<CommandActor> context)

Description copied from interface: ParameterType

Reads input from the given MutableStringStream, parses the object, or throws exceptions if needed.

Note: Lamp makes no guarantees about the times it may invoke this method. It may be called repeatedly for execution, tab completion, finding execution candidates, etc.

As such, it's important to implement the parse method with the following in mind:

• Avoid expensive computations
• Avoid "expensive computations"
• Avoid sending the actor any feedback inside this method. Any feedback should only be sent using exceptions (see CommandErrorException)
• Avoid any side-effects in general. Ideally, this method should be pure.

Specified by:

parse in interface ParameterType<CommandActor,java.lang.Float>

Parameters:

input - The input stream. This argument type is free to consume as much as it needs

context - The command execution context, as well as arguments that have been resolved

Returns:

The parsed object. This should never be null.