Package net.minestom.server.command.builder.arguments.relative

Class ArgumentRelativeBlockPosition

java.lang.Object

net.minestom.server.command.builder.arguments.Argument<T>

net.minestom.server.command.builder.arguments.relative.ArgumentRelative<RelativeBlockPosition>

net.minestom.server.command.builder.arguments.relative.ArgumentRelativeBlockPosition

public class ArgumentRelativeBlockPosition
extends ArgumentRelative<RelativeBlockPosition>

Represents a BlockPosition with 3 integer numbers (x;y;z) which can take relative coordinates.

Example: 5 ~ -3

Field Summary

Fields inherited from class net.minestom.server.command.builder.arguments.relative.ArgumentRelative

INVALID_NUMBER_COUNT_ERROR, INVALID_NUMBER_ERROR, RELATIVE_CHAR

Fields inherited from class net.minestom.server.command.builder.arguments.Argument

SUCCESS, UNDEFINED_ERROR

Constructor Summary

Constructors

Constructor	Description
ArgumentRelativeBlockPosition(java.lang.String id)

Method Summary

Modifier and Type	Method	Description
int	getConditionResult(RelativeBlockPosition value)	Called after Argument.parse(String) meaning that value should already represent a valid representation of the input.
int	getCorrectionResult(java.lang.String value)	First method called to check the validity of an input.
RelativeBlockPosition	parse(java.lang.String value)	Called after Argument.getCorrectionResult(String) returned Argument.SUCCESS.

Methods inherited from class net.minestom.server.command.builder.arguments.relative.ArgumentRelative

getNumberCount

Methods inherited from class net.minestom.server.command.builder.arguments.Argument

allowSpace, getCallback, getId, hasErrorCallback, setCallback, useRemaining

Methods inherited from class java.lang.Object

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

Constructor Details

ArgumentRelativeBlockPosition

public ArgumentRelativeBlockPosition(@NotNull java.lang.String id)

Method Details

getCorrectionResult

public int getCorrectionResult(@NotNull java.lang.String value)

Description copied from class: Argument

First method called to check the validity of an input.

If Argument.allowSpace() is enabled, the value will be incremented by the next word until it returns Argument.SUCCESS, meaning that you need to be sure to check the inexpensive operations first (eg the number of brackets, the first and last char, etc...).

Specified by:

getCorrectionResult in class Argument<RelativeBlockPosition>

Parameters:

value - The received argument

Returns:

the error code or Argument.SUCCESS

parse

@NotNull public RelativeBlockPosition parse(@NotNull java.lang.String value)

Description copied from class: Argument

Called after Argument.getCorrectionResult(String) returned Argument.SUCCESS.

The correction being correct means that value shouldn't be verified again, you can assume that no exception will occur when converting it to the correct type.

Specified by:

parse in class Argument<RelativeBlockPosition>

Parameters:

value - The correct argument which does not need to be verified again

Returns:

The parsed argument

getConditionResult

public int getConditionResult(@NotNull RelativeBlockPosition value)

Description copied from class: Argument

Called after Argument.parse(String) meaning that value should already represent a valid representation of the input.

The condition result has for goal to check the optional conditions that are user configurable (eg min/max values for a number, a specific material for an item, etc...).

Specified by:

getConditionResult in class Argument<RelativeBlockPosition>

Parameters:

value - The parsed argument

Returns:

the error code or Argument.SUCCESS