Package de.eldoria.eldoutilities.commands.command.util

Class Input

java.lang.Object

de.eldoria.eldoutilities.commands.command.util.Input

public class Input
extends Object

Method Summary

Modifier and Type	Method	Description
boolean	asBoolean()	Get the argument as a boolean
boolean	asBoolean(String aTrue, String aFalse)	Get the argument as a boolean
double	asDouble()
<T extends Enum<T>> T	asEnum(Class<T> clazz)	Get the argument as an enum
<T extends Enum<T>> T	asEnum(Class<T> clazz, boolean stripStrings)	Get the argument as an enum
int	asInt()	Get the argument as integer
long	asLong()
@NotNull org.bukkit.Material	asMaterial()	Get the argument as a material.
@NotNull org.bukkit.Material	asMaterial(boolean stripStrings)	Get the argument as a material.
@NotNull org.bukkit.OfflinePlayer	asOfflinePlayer()	Get the argument as a offline player
@NotNull org.bukkit.entity.Player	asPlayer()	Get the argument as a player
@NotNull String	asString()	Get the argument as string
@NotNull org.bukkit.World	asWorld()	Get the argument as a world
static Input	of(org.bukkit.plugin.Plugin plugin, String arg)

Methods inherited from class java.lang.Object

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

Method Details

of

public static Input of(org.bukkit.plugin.Plugin plugin,
 String arg)

asString

@NotNull
public @NotNull String asString()

Get the argument as string

Returns:

argument as string

asInt

public int asInt()
          throws CommandException,
IndexOutOfBoundsException

Get the argument as integer

Returns:

index as integer

Throws:

CommandException - when the argument is not an integer

IndexOutOfBoundsException

asLong

public long asLong()
            throws CommandException,
IndexOutOfBoundsException

Returns:

index as long

Throws:

CommandException - when the argument is not a long

IndexOutOfBoundsException

asDouble

public double asDouble()
                throws CommandException,
IndexOutOfBoundsException

Returns:

index as double

Throws:

CommandException - when the argument is not a double

IndexOutOfBoundsException

asBoolean

public boolean asBoolean()
                  throws CommandException,
IndexOutOfBoundsException

Get the argument as a boolean

Returns:

index as boolean

Throws:

CommandException - when the argument is not a boolean

IndexOutOfBoundsException

asBoolean

public boolean asBoolean(String aTrue,
 String aFalse)
                  throws CommandException,
IndexOutOfBoundsException

Get the argument as a boolean

Parameters:

aTrue - value of true

aFalse - value of false

Returns:

index as boolean

Throws:

CommandException - when the argument is not a boolean

IndexOutOfBoundsException

asMaterial

@NotNull
public @NotNull org.bukkit.Material asMaterial()
                                        throws CommandException,
IndexOutOfBoundsException

Get the argument as a material.

This will send a custom message without listing all possible values.

Returns:

index as material

Throws:

CommandException - when the argument is not a material

IndexOutOfBoundsException

asMaterial

@NotNull
public @NotNull org.bukkit.Material asMaterial(boolean stripStrings)
                                        throws CommandException,
IndexOutOfBoundsException

Get the argument as a material.

This will send a custom message without listing all possible values.

Parameters:

stripStrings - if true underscores will be removed before checking

Returns:

index as material

Throws:

CommandException - when the argument is not a material

IndexOutOfBoundsException

asEnum

@NotNull
public <T extends Enum<T>> T asEnum(Class<T> clazz)
                             throws CommandException,
IndexOutOfBoundsException

Get the argument as an enum

Type Parameters:

T - type of enum

Parameters:

clazz - enum clazz to parse

Returns:

index as enum value

Throws:

CommandException - When the string could not be parsed to an enum

IndexOutOfBoundsException

asEnum

@NotNull
public <T extends Enum<T>> T asEnum(Class<T> clazz,
 boolean stripStrings)
                             throws CommandException,
IndexOutOfBoundsException

Get the argument as an enum

Type Parameters:

T - type of enum

Parameters:

clazz - enum clazz to parse

stripStrings - if true underscores will be removed before checking

Returns:

index as enum value

Throws:

CommandException - When the string could not be parsed to an enum

IndexOutOfBoundsException

asPlayer

@NotNull
public @NotNull org.bukkit.entity.Player asPlayer()
                                           throws CommandException,
IndexOutOfBoundsException

Get the argument as a player

Returns:

index as player

Throws:

CommandException - when no player with this name is online

IndexOutOfBoundsException

asOfflinePlayer

@NotNull
public @NotNull org.bukkit.OfflinePlayer asOfflinePlayer()
                                                  throws CommandException,
IndexOutOfBoundsException

Get the argument as a offline player

Returns:

index as offline player

Throws:

CommandException - when no player with this name was on this server previously

IndexOutOfBoundsException

asWorld

@NotNull
public @NotNull org.bukkit.World asWorld()
                                  throws CommandException,
IndexOutOfBoundsException

Get the argument as a world

Returns:

index as world

Throws:

CommandException - When the string is not the name of a world

IndexOutOfBoundsException